Skip to main content
POST
Criar colaborador

Authorizations

X-API-Key
string
header
required

Chave de API gerada na plataforma em Integrações → API Keys

Headers

Idempotency-Key
string

Chave opcional para evitar duplicação em retries de rede. Se a mesma chave for reenviada para o mesmo endpoint dentro de 24h, a resposta original é retornada (sem repetir o efeito colateral), com o header Idempotent-Replay: true.

Body

application/json
name
string
required
Example:

"Ana Lima"

whatsapp_id
string
required

Número de WhatsApp do colaborador

Example:

"5511988887777"

Response

Colaborador criado com sucesso

id
string<uuid>

Identificador único do colaborador

name
string

Nome do colaborador

whatsapp_id
string

Número de WhatsApp do colaborador

is_active
boolean

Se o colaborador está ativo e pode receber atribuições