Skip to content

Campos Personalizados do Cliente

Define ou atualiza o valor de um campo personalizado do cliente.

Endpoint

http
POST /api/{organizationId}/customers/{customerId}/field-values

Base URL: https://v1.api.interflow.chat

Autenticação

http
x-api-key: ak_sua_api_key

Body

CampoTipoObrigatórioDescrição
slugstringCondicionalSlug do campo (obrigatório se não enviar field_definition_id)
field_definition_idstring (UUID)CondicionalID da definição do campo
valueanySimValor (validado conforme o tipo do campo)

Exemplo

bash
curl -X POST "https://v1.api.interflow.chat/api/{organizationId}/customers/{customerId}/field-values" \
  -H "Content-Type: application/json" \
  -H "x-api-key: ak_sua_api_key" \
  -d '{
    "slug": "cidade",
    "value": "São Paulo"
  }'

Resposta

Sucesso

json
{
  "success": true,
  "data": { }
}

Erros

HTTPSituação
400slug/field_definition_id ou value ausente / valor inválido para o tipo
404Cliente ou campo não encontrado

TIP

Nesta versão a API permite definir valores de campos no cliente. A gestão das definições dos campos não está disponível por API.

Documentación en constante actualización