Skip to main content
POST
/
contacts
/
create
Criar um contato
curl --request POST \
  --url https://api.botly.com.br/api/v1/rest/contacts/create \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "João Silva",
  "email": "joao@exemplo.com",
  "phone": "11999999999",
  "whatsapp": "5511999999999"
}
'
{
  "id": "<string>",
  "avatar": "<string>",
  "name": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "whatsapp": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "agentId": "<string>"
}

Authorizations

x-api-key
string
header
required

Body

application/json
name
string
required

Nome do contato

Example:

"João Silva"

email
string

E-mail do contato (opcional)

Example:

"joao@exemplo.com"

phone
string

Telefone do contato (opcional)

Example:

"11999999999"

whatsapp
string

Número do WhatsApp do cliente ou o LID (identificador gerado pelo WhatsApp em alguns casos)

Example:

"5511999999999"

Response

Contato criado com sucesso

id
string

Identificador único do contato

avatar
string | null

URL do avatar do contato

name
string

Nome do contato

email
string | null

E-mail do contato

phone
string | null

Telefone do contato

whatsapp
string | null

Número ou LID do WhatsApp

createdAt
string<date-time>

Data de criação do contato

updatedAt
string<date-time>

Data da última atualização

agentId
string

Identificador do agente associado ao contato