Skip to main content
PUT
Atualizar contato

Autorizações

Authorization
string
header
obrigatório

Token da API no formato sk_live_….

Parâmetros de caminho

id
integer
obrigatório

Corpo

application/json

Campos que podem ser gravados em um contato. A foto (profilePicUrl) não pode ser alterada por aqui, porque vem do provedor (WhatsApp/Instagram) e é atualizada por ele. Ela continua sendo devolvida na leitura.

name
string
obrigatório

Nome do contato, como aparece na lista e no atendimento.

Exemplo:

"Marina Alves"

number
string

Telefone com DDI e DDD. Pode vir formatado, como +55 (11) 99999-9999, e só os dígitos são gravados. O país do contato (numberCountry) é deduzido do DDI, e um número sem DDI de país válido responde 422. Ele identifica o contato no upsert e define o destinatário no envio de mensagens.

Exemplo:

"5511999999999"

email
string

E-mail do contato. Não serve para login, já que contato não é usuário do sistema.

Exemplo:

"marina@exemplo.com.br"

code
string

Identificador do contato no seu sistema. Se você preencher desde a criação, pode reencontrar o contato depois com GET /contacts?code=..., sem depender do telefone, que pode mudar.

Exemplo:

"CLI-8842"

origin
string

Origem do contato. Texto livre, usado nos relatórios.

Exemplo:

"Site"

cpfcnpj
string

CPF ou CNPJ. Gravado exatamente como enviado, sem formatação.

Exemplo:

"12345678909"

instagramUsername
string

Usuário do Instagram, sem o @.

Exemplo:

"marina.alves"

customFields
object[]

Campos personalizados a gravar. Identifique cada campo pela key, que não muda, enquanto o name pode ser renomeado no painel a qualquer momento.

Um valor vazio remove o campo do contato. Campos que não aparecem no corpo ficam como estão.

A gravação é tudo ou nada. Se algum valor não passar na validação do tipo, a resposta é 400 e nenhum campo é gravado.

sourceUrl
string

Página em que o contato converteu, como a URL do anúncio ou do formulário.

Exemplo:

"https://loja.exemplo.com.br/promo"

sourceId
string

Id, no provedor, do anúncio ou da publicação que originou o contato.

Exemplo:

"23851234567890123"

headline
string

Título do anúncio ou da publicação de origem.

Exemplo:

"Coleção de inverno"

utmSource
string

Parâmetro utm_source da origem. É usado no relatório de conversas.

Exemplo:

"instagram"

utmMedium
string

Parâmetro utm_medium.

Exemplo:

"cpc"

utmCampaign
string

Parâmetro utm_campaign.

Exemplo:

"inverno-2026"

utmId
string

Parâmetro utm_id, quando a plataforma de anúncios o envia.

Exemplo:

"6543210987"

Resposta

OK

data
object
Exemplo: