Start a flow execution

POST

/flows/{flow_uuid}/executions

Requisição

Authorization

Bearer Token

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros de Caminho

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢202Accepted

application/json

Operation accepted

Headers

Bodyapplication/json

🟠409Error

🟠422Error

Request Example

Shell

JavaScript

Java

Swift

curl --location '/flows//executions' \
--header 'Idempotency-Key;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "channel_uuid": "82940f04-367e-448c-ae9d-3ae74b17da5e",
    "recipient": {
        "phone": "+5511999999999",
        "external_id": "string"
    },
    "variables": {
        "property1": "string",
        "property2": "string"
    }
}'

Response Example

202 - Exemplo 1

{
    "data": {
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "type": "message.send",
        "status": "queued",
        "result": {
            "property1": "string",
            "property2": "string"
        },
        "error": {
            "code": "string",
            "message": "string"
        },
        "created_at": "2019-08-24T14:15:22.123Z",
        "started_at": "2019-08-24T14:15:22.123Z",
        "completed_at": "2019-08-24T14:15:22.123Z"
    }
}

Modificado em 2026-08-26 00:52:01

Página anterior

Get a flow

Próxima página

List WhatsApp templates