Skip to main content
POST
Criar ou atualizar um contato pelo telefone

Como funciona

A rota decide pelo telefone. Se a organização já tem um contato com esse número, ele é atualizado com o que você enviou e a resposta é 200 com created: false. Sem ele, um contato novo é criado e a resposta é 201 com created: true.
  • O que você não envia fica como está. Para tirar o nome, o e-mail ou a empresa, envie null.
  • tags substitui a lista inteira. Para acrescentar uma tag sem perder as outras, leia o contato antes e envie a lista completa.
  • company é o nome da empresa. A empresa de mesmo nome é reaproveitada, e uma nova é criada quando não existe.
  • custom_fields preenche as colunas personalizadas, pela chave de cada coluna. As chaves que não vierem ficam como estão, e null tira o valor.

Colunas personalizadas

Cada chave de custom_fields tem que ser de uma coluna ativa de contato. Crie as colunas no painel, em CRM > Contatos > Nova coluna ou em CRM > Configurações, ou pela rota Criar ou atualizar coluna.
Uma chave que não existe, ou um valor fora do tipo da coluna, recusa a requisição inteira com 400. A mensagem aponta a chave: custom_fields.cargo: no active custom field with this key in this organization. Nada é gravado.

Exemplo

Erros

Authorizations

Authorization
string
header
required

API Key da organização (Authorization: Bearer ik_live_xxx)

Body

application/json
phone
string
required

Telefone em E.164, com o + e o código do país (+5511987654321). Espaço, parênteses, ponto e traço são aceitos e saem. Celular brasileiro sem o 9º dígito ganha o 9

Required string length: 1 - 40
Example:

"+5511987654321"

name
string | null

Nome; null tira

Required string length: 1 - 160
email
string | null
Maximum string length: 254
Pattern: ^[^\s@]+@[^\s@]+\.[^\s@]+$
Example:

"ana@clinica.com.br"

company
string | null

Nome da empresa: a de mesmo nome (sem diferença de maiúscula) ou uma nova. null tira a empresa do contato

Required string length: 1 - 160
tags
string[]

Até 30 tags, cada uma com até 40 caracteres; a repetida sai. Substitui a lista inteira

Maximum array length: 30
Required string length: 1 - 40
Example:
custom_fields
object

Campos personalizados (os criados no painel, em CRM > Configurações), pela chave: texto (até 500), número, data (AAAA-MM-DD), uma das opções da seleção ou true/false. null tira o valor. As chaves que não vierem ficam como estão

Example:

Base legal (LGPD): consent, legitimate_interest, contract ou legal_obligation

Available options:
consent,
legitimate_interest,
contract,
legal_obligation
opt_out
boolean

true: não quer ser contatado (a campanha pula); false desfaz

Response

Já existia: atualizado (created: false)

created
boolean
required
contact
object
required