Send a published flow as an interactive message

Authorization

Bearer

AuthorizationBearer <token>

API key (rlay_live_* or rlay_test_). Invite redemption also accepts a server-derived rlay_session_ bearer for a current user session.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

account_id*string

WhatsApp account ID

body_text*string

Message body text

cta_text*string

CTA button text

flow_data?

Initial data to pass to the flow

flow_id*string

Published flow ID

flow_token*string

Unique token for this flow session

footer_text?string

Message footer text

header_text?string

Message header text

recipient_phone*string

Recipient phone number in E.164 format

screen_id*string

Initial screen ID to display

Response Body

`application/json`

curl -X POST "https://example.com/v1/whatsapp/flows/send" \  -H "Content-Type: application/json" \  -d '{    "account_id": "string",    "body_text": "string",    "cta_text": "string",    "flow_id": "string",    "flow_token": "string",    "recipient_phone": "string",    "screen_id": "string"  }'

{  "message_id": "string"}

Found something wrong? Help us improve this page.

Report an issue Edit this page on GitHub

Publish a flow (irreversible) POST

Update WhatsApp Business profile PUT

Send a published flow as an interactive message

Authorization

Request Body

Response Body

200application/json

401application/json

`application/json`

`application/json`