Skip to main content
PATCH
Alterar um contato
Envie só o que muda. tags substitui a lista inteira, e custom_fields segue as mesmas regras de Criar ou atualizar contato. Trocar o telefone para um número que já é de outro contato da organização responde 409.

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

ID do contato (UUID)

Body

application/json
phone
string | null

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

O contato alterado

id
string
required
name
string | null
required
email
string | null
required
phone
string | null
required

E.164 (nulo no contato só do Instagram ou do Messenger)

company
object | null
required
source
enum<string>
required

De onde veio: manual, import, api, assistant, call, whatsapp, instagram, messenger ou campaign

Available options:
manual,
import,
api,
assistant,
call,
whatsapp,
instagram,
messenger,
campaign
tags
string[]
required
custom_fields
object
required

Base legal (LGPD)

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

Não quer ser contatado (a campanha pula)

opt_out_at
string | null
required

Desde quando

Example:

"2026-11-02T14:00:00.000Z"

last_interaction_at
string | null
required

Última ligação ou conversa

Example:

"2026-11-02T14:00:00.000Z"

created_at
string
required

Criação (UTC)

Example:

"2026-11-02T14:00:00.000Z"

updated_at
string
required

Última mudança (UTC)

Example:

"2026-11-02T14:00:00.000Z"