Inicia uma execução de fluxo

Cria uma execução no orquestrador e persiste o estado inicial no Runner. O Authorization desta requisição (access_token) é repassado ao orquestrador, que o introspecciona para identificar a conta dona do flow.
Canal whatsapp (padrão): Runner envia mensagens automáticas via WhatsApp — apresentação, links de form/verify/signature e conclusão. contact.phone_number é obrigatório.
Canal api: Runner não envia mensagens automáticas. A resposta inclui current_step.url com o link do passo atual para o cliente entregar ao contato. contact.phone_number é opcional. Exceção: steps acceptance sempre enviam WhatsApp (interação funcional) e falham se o contato não tiver phone_number.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Flow ID

Body Params

Contato

string
enum

Canal de comunicação da execução.
"whatsapp" (padrão, compatível com versões anteriores): Runner envia mensagens automáticas via WhatsApp em todas as etapas — apresentação, steps form/verify/signature e conclusão. contact.phone_number é obrigatório.
"api": Runner não envia mensagens automáticas. O cliente é responsável por entregar os links ao contato. A resposta inclui o objeto current_step com id, type e url do passo em andamento. contact.phone_number é opcional (exceto para steps acceptance, que sempre exigem WhatsApp).
Omitir o campo equivale a "whatsapp". Qualquer outro valor retorna 400.

Allowed:
contact
object
files
array of objects

Arquivo(s) enviados em base64 no próprio disparo. Opcional (aditivo) — sem este
campo, o comportamento atual é mantido. Cada item tem content_base_64 (data-URL
completa, ex.: "data:application/pdf;base64,...") e key — o step signature do fluxo
declara documents[].kind "runner_files" com o mesmo key pra casar o conteúdo com o
slot certo (nome do arquivo é definido no fluxo, não aqui).

files
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json