Skip to main content
POST
Disparar um flow do FlowBuilder para um número

Authorizations

Authorization
string
header
required

Token criado em API → Tokens no painel. Prefixo wtx_live_ (ou wtx_test_).

Body

application/json
flowId
integer
required
whatsappId
integer
required

Conexão (canal whatsapp/waba) da conta.

number
string
required

Telefone do contato (E.164 ou variantes BR).

contactName
string

Nome usado se o contato for criado.

variables
object

Reservado; hoje não chega ao flow. O valor é aceito e registrado no evento de disparo, mas o executor do FlowBuilder não lê variables — o flow só enxerga as variáveis nativas do contato/conversa ({{nome}}, {{telefone}}, {{protocolo}}, {{data}}, {{hora}}). Para levar um dado seu ao flow, grave-o no contato via POST /v1/contacts (extraInfo) antes de disparar.

force
boolean
default:false

Sobrepõe a guarda de atendimento humano ativo (409).

Response

Flow validado e disparado em background no ticket devolvido.

requestId
string
accepted
boolean
ticketId
integer
contactId
integer