Cadastrar contato

curl --request POST \ --url https://api.liderhub.com.br/v1/contacts \ --header 'Content-Type: application/json' \ --header 'x-company-key: <api-key>' \ --data ' { "connection": "e3c9be60-fbe0-4630-abd2-d6b3d699c9b2", "number": "554892171075", "name": "Maria Silva", "email": "[email protected]", "agent": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "user": "11111111-2222-3333-4444-555555555555", "status": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } '

Autorizações

x-company-key

string

header

obrigatório

Chave de autenticação do workspace (gerada na plataforma Liderhub)

Corpo

application/json

connection

string<uuid>

obrigatório

ID da conexão — o mesmo id retornado em GET /v1/connections.

Exemplo:

"e3c9be60-fbe0-4630-abd2-d6b3d699c9b2"

number

string

obrigatório

Número para validação no WhatsApp (DDI + dígitos, com ou sem +).

Exemplo:

"554892171075"

name

string

Nome exibido no chat (string; não envie objeto).

Exemplo:

"Maria Silva"

string

E-mail associado ao contato (string).

Exemplo:

"[email protected]"

agent

string<uuid>

Agente de IA — mesmo id que recebe em GET /v1/agents.

user

string<uuid>

Usuário humano — mesmo campo user que recebe em GET /v1/users.

status

string<uuid>

Label de status — mesmo campo status na resposta de chat. GET /v1/settings/status.

Resposta

exist: false se o número não for WhatsApp válido; caso contrário exist, id e created.

exist

boolean

obrigatório

Indica se o número existe no WhatsApp.

Exemplo:

true

string<uuid>

Presente quando exist é true: UUID do chat/contato (Chat.id).

Exemplo:

"1cbcb7a8-8bf6-4016-8ed5-8ea38c4a9a05"

created

boolean

Presente quando exist é true: true se o chat foi criado nesta chamada.

Exemplo:

true