Skip to main content
PATCH
Atualizar a contact

Parâmetros de caminho

inbox_identifier
string
obrigatório

O identificador obtido do canal API de caixa de entrada

contact_identifier
string
obrigatório

O id de origem do contato obtido na criação do contato

Corpo

application/json
identifier
string

Identificador externo do contato

Exemplo:

"1234567890"

identifier_hash
string

Hash de identificador preparado para autenticação HMAC

Exemplo:

"e93275d4eba0e5679ad55f5360af00444e2a888df9b0afa3e8b691c3173725f9"

email
string

E-mail do contato

Exemplo:

"alice@acme.inc"

name
string

Nome do contato

Exemplo:

"Alice"

phone_number
string

Número de telefone do contato

Exemplo:

"+123456789"

avatar
file

Envie os dados do formulário com o binário da imagem do avatar ou use a avatar_url

custom_attributes
object

Atributos personalizados do cliente

Exemplo:

Resposta

Sucesso

Registro de contato serializado completo retornado quando a API pública renderiza um modelo de Contato diretamente.

id
integer

Id do contato

name
string | null

Nome do contato quando disponível

email
string | null

E-mail do contato

phone_number
string | null

Número de telefone do contato

identifier
string | null

Identificador do contato

blocked
boolean

Se o contato está bloqueado

additional_attributes
object | null

Atributos adicionais do contato, quando presentes

custom_attributes
object | null

Atributos personalizados do contato, quando presentes

contact_type
string | null

Tipo de contato do contato, quando disponível

country_code
string | null

Código do país do contato

last_activity_at
string | null

Carimbo de data/hora da última atividade do contato no formato ISO 8601

created_at
string | null

Carimbo de data/hora de criação do contato no formato ISO 8601

updated_at
string | null

Carimbo de data/hora de atualização do contato no formato ISO 8601

last_name
string | null

Sobrenome do contato

middle_name
string | null

Nome do meio do contato

location
string | null

Localização do contato

account_id
integer

Id da conta do contato

company_id
integer | null

Id da empresa do contato

label_list
string[]

Rótulos aplicados ao contato