Skip to content

Criar Cliente

Cria um cliente na organização.

Endpoint

http
POST /api/{organizationId}/customers

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

Autenticação

http
x-api-key: ak_sua_api_key

Body

CampoTipoObrigatórioDescrição
namestringSimNome do cliente
contactsarrayCondicionalContatos (type + value). Obrigatório ter ao menos um contato alcançável (contato ou e-mail)
emailstringNãoE-mail principal
stageIdstring (UUID)NãoEstágio do funil CRM
documentstringNãoDocumento (CPF/CNPJ etc.)
countrystringNãoPaís
person_typestringNãoTipo de pessoa
salePricenumberNãoValor de venda no estágio
selectedTagsstring[]NãoIDs de tags
customFieldsarrayNãoCampos personalizados na criação
allowDuplicateContactsbooleanNãoSe true, permite duplicar contatos/documento/e-mail

Item de contacts

CampoTipoDescrição
typestringEx.: whatsapp, phone, email, instagram, facebook, telegram
valuestringValor do contato
labelstringRótulo opcional

Exemplo

bash
curl -X POST "https://v1.api.interflow.chat/api/{organizationId}/customers" \
  -H "Content-Type: application/json" \
  -H "x-api-key: ak_sua_api_key" \
  -d '{
    "name": "Maria Silva",
    "email": "maria@example.com",
    "contacts": [
      { "type": "whatsapp", "value": "5511999999999" }
    ],
    "stageId": "stage-uuid"
  }'

Resposta

Sucesso

Cliente criado (success: true e dados do cliente).

Erros

HTTPSituação
400Nome ausente / sem contato / estágio inválido
409Duplicidade de contato, e-mail ou documento
404Organização não encontrada

Relacionados

Documentação em constante atualização