Send Flow

Send a message with a button that opens a WhatsApp Flow.

Authorization

HTTPBearer

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

client_id*Client Id

The UUID of the WhatsApp client

to*To

Recipient phone number with country code

body*Body

Message body text shown above the flow button

button_text*Button Text

Label of the button that opens the flow (max 20 chars)

flow_id*Flow Id

ID of the flow to send

screen?|

Entry screen ID — required for flows that navigate on open

flow_token?|

Token echoed back in the flow completion webhook

payload?|

Initial data passed to the entry screen

mode?Mode

Send the published version or the draft (draft only reaches testers)

Default"published"

Value in"published" | "draft"

footer?string|null

tracker?|

Opaque string echoed back in the message status webhook (up to 512 chars)

Response Body

`application/json`

curl -X POST "https://example.com/api/messaging/send-flow" \  -H "Content-Type: application/json" \  -d '{    "client_id": "string",    "to": "string",    "body": "string",    "button_text": "string",    "flow_id": "string"  }'

null

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Authorization

Request Body

Response Body

200application/json

422application/json

`application/json`

`application/json`