Pular para o conteúdo principal
POST
Ativar flow

Autorizações

Authorization
string
header
obrigatório

API key criada nas configurações da organização.

Cabeçalhos

Idempotency-Key
string

Chave única da operação. Repetir a mesma chave com o mesmo corpo devolve a resposta original em vez de executar de novo.

Parâmetros de caminho

flow_id
string
obrigatório

ID público do flow.

Pattern: ^flw_[A-Za-z0-9_-]+$

Corpo

application/json
revision
string
obrigatório

Revisão revisada pela pessoa, retornada na criação do rascunho ou na consulta do flow.

Pattern: ^rev_[0-9a-f]+$

Resposta

Flow encontrado.

object
string
obrigatório
Allowed value: "flow"
id
string
obrigatório
Pattern: ^flw_[A-Za-z0-9_-]+$
status
string
obrigatório
created_at
string<date-time>
obrigatório
updated_at
string<date-time>
obrigatório
html_url
string<uri>
obrigatório
name
string
description
string
trigger_event_type
string
origin
string
run_count
integer
obsoleto

Campo legado descontinuado, mantido por compatibilidade. Quando presente, retorna sempre 0; não representa o total real de execuções.

Intervalo obrigatório: x >= 0
revision
string

Identifica o conteúdo atual do flow (blocos e conexões). Informe-a ao ativar o flow para garantir que só o conteúdo revisado entre no ar.