Skip to main content
POST
Criar Contact

Autorizações

api_access_token
string
header
obrigatório

Este token pode ser obtido visitando a página de perfil ou por meio do console rails. Fornece acesso a endpoints com base nos níveis de permissões do usuário. Este token pode ser salvo por um sistema externo quando o usuário é criado via API, para realizar atividades em nome do usuário.

Parâmetros de caminho

account_id
integer
obrigatório

O ID numérico da conta

Corpo

application/json
inbox_id
number
obrigatório

ID da caixa de entrada à qual o contato pertence

Exemplo:

1

name
string

nome do contato

Exemplo:

"Alice"

email
string

e-mail do contato

Exemplo:

"alice@acme.inc"

blocked
boolean

se o contato está bloqueado ou não

Exemplo:

false

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

avatar_url
string

O url para um arquivo jpeg, png para o avatar do contato

Exemplo:

"https://example.com/avatar.png"

identifier
string

Um identificador exclusivo para o contato no sistema externo

Exemplo:

"1234567890"

additional_attributes
object

Um objeto onde você pode armazenar atributos adicionais para o contato. exemplo {"type":"customer", "age":30}

Exemplo:
custom_attributes
object

Um objeto onde você pode armazenar atributos personalizados para o contato. exemplo {"type":"customer", "age":30}, isso deve ter uma definição de atributo personalizado válida.

Exemplo:

Resposta

Sucesso

payload
object[]
id
number

Id do usuário

availability_status
enum<string>

Status de disponibilidade do usuário

Opções disponíveis:
online,
offline