Skip to main content
POST
Inicia (ou continua) a conversa de WhatsApp com um lead

Authorizations

Authorization
string
header
required

Authorization: Bearer mcp_… — gere em Configurações → Tokens de API.

O token de API tem modo read ou write. Um token read responde 403 a qualquer verbo que não seja GET. As capacidades do token são a interseção com as da pessoa de quem ele herda o papel: se ela perder acesso na grade de Equipe, o token perde junto, sem ninguém revogar nada.

Token de agência (gerado no console da agência): vale para as empresas da agência, e a empresa de cada chamada vai no header X-Empresa: <slug da empresa>. Sem o header, 401. Num token de empresa o header é opcional e, se vier, tem de ser a própria empresa. O modo read vale igual: um token de agência de leitura só faz GET — é o token para pôr numa função que só consulta.

Headers

Idempotency-Key
string
required
Maximum string length: 200
Example:

"recuperacao-ana-2026-11-14"

Body

application/json
phone
string
required

O telefone do lead (com DDD). Com lead_id, tem que ser o dele.

Example:

"11987654321"

channel
enum<string>
default:whatsapp
Available options:
whatsapp
text
string
Maximum string length: 4096
media_url
string

Só a URL devolvida por POST /v1/midia. Junto com media_type.

media_type
enum<string>
Available options:
image,
audio,
ptt,
video,
document
lead_id
string<uuid>
forcar
boolean
default:false

Envia mesmo com a IA pausada por uma pessoa.

Response

Repetição da mesma Idempotency-Key (duplicate: true)