Saltar para o conteúdo principal
POST
Criar ou atualizar contato

Autorizações

Authorization
string
header
obrigatório

Token de acesso da subconta ou token de integração privada da subconta. Informe no cabeçalho Authorization usando Bearer. A leitura exige contacts.readonly; a criação e a atualização exigem contacts.write.

Cabeçalhos

Version
enum<string>
obrigatório

Versão da API. Utilize o valor v3.

Opções disponíveis:
v3
Exemplo:

"v3"

Corpo

application/json
locationId
string
obrigatório

ID da subconta em que o contato será criado.

Exemplo:

"ve9EPM428h8vShlRW1KT"

firstName
string | null

Primeiro nome do contato.

Exemplo:

"Rosan"

lastName
string | null

Sobrenome do contato.

Exemplo:

"Deo"

name
string | null

Nome completo do contato.

Exemplo:

"Rosan Deo"

email
string | null

Endereço de e-mail do contato.

Exemplo:

"rosan@deos.com"

gender
string

Gênero do contato.

Exemplo:

"male"

phone
string | null

Número de telefone do contato.

Exemplo:

"+1 888-888-8888"

address1
string | null

Endereço do contato.

Exemplo:

"3535 1st St N"

city
string | null

Cidade do contato.

Exemplo:

"Dolomite"

state
string | null

Estado do contato.

Exemplo:

"AL"

postalCode
string

Código postal do contato.

Exemplo:

"35061"

website
string | null

URL do site do contato.

Exemplo:

"https://www.tesla.com"

timezone
string | null

Fuso horário do contato.

Exemplo:

"America/Chihuahua"

dnd
boolean

Indica se o modo não perturbe (DND) está habilitado para o contato.

Exemplo:

true

inboundDndSettings
object

Configurações de não perturbe (DND) para comunicações recebidas por canal do contato.

Exemplo:
tags
string[]

Este campo substitui todas as etiquetas atuais do contato. Para adicionar ou remover uma etiqueta sem substituir as demais, utilize os endpoints específicos de etiquetas.

Exemplo:
customFields
object[]

Lista de valores de campos personalizados a atribuir ao contato.

Exemplo:
source
string

Origem da criação do contato.

Exemplo:

"public api"

dateOfBirth
object | null

Data de nascimento do contato. Formatos aceitos: YYYY/MM/DD, MM/DD/YYYY, YYYY-MM-DD, MM-DD-YYYY, YYYY.MM.DD, MM.DD.YYYY, YYYY_MM_DD, MM_DD_YYYY.

Exemplo:

"1990-09-25"

country
string

Código do país do contato no padrão ISO 3166-1 alfa-2.

Exemplo:

"US"

companyName
string | null

Nome da empresa do contato.

Exemplo:

"DGS VolMAX"

assignedTo
string

ID do usuário.

Exemplo:

"y0BeYjuRIlDwsDcOHOJo"

createNewIfDuplicateAllowed
boolean
padrão:false

Controla a criação de um contato ou a atualização de um contato duplicado existente. Cenário 1: quando o valor é true e a subconta permite contatos duplicados, um novo contato é criado imediatamente, sem verificação de duplicidade. Cenário 2: quando o valor é true e a subconta não permite duplicados, o campo é ignorado e vale o comportamento normal de criar ou atualizar: a API procura um contato duplicado, atualiza-o se encontrar ou cria um novo se não encontrar. Cenário 3: quando o valor é false ou não é informado, vale o comportamento normal de criar ou atualizar, independentemente da configuração de duplicidade da subconta.

Exemplo:

false

dndSettings
object

Configurações de não perturbe (DND) por canal do contato.

Exemplo:

Resposta

Resposta de sucesso.

new
boolean

Indica se um novo contato foi criado (true) ou se um contato existente foi atualizado (false).

Exemplo:

true

contact
object

Dados do contato.

Exemplo:
traceId
string

Identificador único de rastreamento desta operação.

Exemplo:

"abc123trace"