HypeConversa

Plataforma · Fluxos

Disparar fluxo

Acha ou cria o contato pelo telefone e inicia o fluxo.

POST
/instances/{INSTANCE_TOKEN}/flows/{id}/trigger

Atributos

Cabeçalho

Client-Tokenstringobrigatório

Token da conta. Envie o valor puro, sem o prefixo Bearer.

Caminho

idstringobrigatório

ID do fluxo.

Corpo

phonestringobrigatório

Número de destino (DDI + DDD + número, só dígitos).

Resposta

200Veja o corpo de exemplo na referência.
Disparar fluxo
curl --request POST \
  --url https://api.hypeconversa.com/instances/{INSTANCE_TOKEN}/flows/{id}/trigger \
  --header 'Client-Token: SEU_TOKEN_DE_CONTA' \
  --header 'Content-Type: application/json' \
  --data '{ "phone": "5511999999999" }'
200
json
{
  "contactId": "uuid",
  "flowId": "uuid",
  "status": "triggered"
}