Atualizar por Número de telefone

Path Params

phone

string

required

Número de telefone.

Body Params

Dados para atualização do contato.

fields

array of strings

required

Campos a serem atualizados.

fields*

name

string | null

Nome do contato.

phoneNumber

string | null

Número no WhatsApp.

string | null

Endereço de email.

instagram

string | null

Nome de usuário no Instagram.

annotation

string | null

Notas internas da equipe.

tagIds

array of uuids | null

IDs das etiquetas atribuídas.

tagIds

tagNames

array of strings | null

Nomes das etiquetas atribuídas. Este campo será ignorado caso TagIds seja definido.

tagNames

status

string | null

enum

Status do contato.

Allowed:

pictureUrl

string | null

Informe neste campo uma Url para definição da imagem do contato

customFields

object | null

Objeto chave-valor para definir valores de campos personalizados no contato.
Cada item do objeto deverá ter como nome a chave do campo personalizado.
Caso a chave não corresponda a algum campo personalizado ou o tipo de dados do valor seja incompatível, o item será ignorado.

metadata

object | null

Metadados relevantes para o contato. Neste campo, pode ser salvo qualquer propriedade adicional para o contato, na estrutura chave-valor.

Para adicionar um metadado: utilize uma chave não utilizada anteriormente neste contato, atribuindo o novo valor;
Para atualizar um metadado: utilize a chave salva anteriormente neste contato, atribuindo o novo valor;
Para remover um metadado: utilize a chave salva anteriormente, atribuindo valor nulo.

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

200Success

500Server Error