Pular para o conteúdo principal
POST
Atualizar um contato

Autorizações

Authorization
string
header
obrigatório

Autentique com uma chave secreta (sk_live_…) ou uma chave restrita (rk_live_…) criada no painel. Chaves restritas só têm as permissões escolhidas na criação, como messages:send, chats:read ou broadcasts:send.

Cabeçalhos

Idempotency-Key
string

Uma chave única, como um UUID, que torna seguro repetir esta requisição por 24 horas.

Maximum string length: 255
Blu-Version
string

A versão da API a usar. Por padrão, é a versão fixada na sua conta.

Exemplo:

"2026-10-11"

Parâmetros de caminho

contact
string
obrigatório
Pattern: ^cont_

Corpo

application/json
profile
object
labels
string[]

Substitui as etiquetas do contato.

Pattern: ^lbl_
opted_out
boolean

Marque quando o contato pedir para não receber mensagens. As campanhas pulam esses contatos em todos os números.

metadata
object

Até 50 pares de chave e valor seus. Chaves com até 40 caracteres e valores com até 500.

Resposta

O contato atualizado.

id
string
obrigatório
Pattern: ^cont_
Exemplo:

"cont_7Hk1"

object
string
obrigatório
Allowed value: "contact"
wa_id
string
obrigatório
Exemplo:

"5511988887777"

profile
object
obrigatório
labels
(string | object)[]
obrigatório

As etiquetas do contato. Expansível.

Pattern: ^lbl_
opted_out
boolean
obrigatório

O contato pediu para não receber mensagens. As campanhas o pulam em todos os números.

opted_out_at
integer | null
obrigatório
marketing_stopped
boolean
obrigatório

O contato bloqueou mensagens de marketing no WhatsApp. Campanhas de marketing o pulam.

created
integer
obrigatório

Horário Unix em segundos.

Exemplo:

1760190012

metadata
object
obrigatório

Até 50 pares de chave e valor seus. Chaves com até 40 caracteres e valores com até 500.