Skip to main content
POST
Iniciar conversa com um contato novo

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
channel_id
integer
required

Canal de WhatsApp da empresa (type wba, whatsapp ou ww) — veja GET /company/{id}/channels.

phone
string
required
Example:

"+5511999999999"

name
string
required
send_type
enum<string>
required
Available options:
template,
text
lastname
string
template_name
string

Obrigatório se send_type=template. Só vale pra canais wba/whatsapp.

language
string
Example:

"pt_BR"

variables
object

Atalho pras variáveis do template — mapa {"1": "valor"}.

text
string

Obrigatório se send_type=text. Em canais wba/whatsapp só funciona dentro da janela de 24h.

content_type
string

Só em canal ww. image, video, audio ou document (aceita também MIME completo, ex: image/png).

file_url
string

Só em canal ww. Obrigatório content_type junto.

file_name
string

Só em canal ww, opcional.

topic
string
pipeline_id
integer
pipeline_stage_id
integer

Response

Mensagem enviada

success
boolean
data
object