v2

latestOpenAPI 3.1.02026-08-075421692.0 MB

WhatsApp Flows

Send flow message

Send a published flow as an interactive message with a CTA button. When the recipient taps the button, the flow opens natively in WhatsApp. Flow responses are received via webhooks.

post/v1/whatsapp/flows/send

Request body

accountIdstring required

WhatsApp social account ID

tostring required

Recipient phone number (E.164 format, e.g. +1234567890)

flow_idstring required

Published flow ID

flow_ctastring required

CTA button text (e.g. 'Book Now', 'Sign Up')

flow_action'navigate' | 'data_exchange'

Action type: navigate opens a screen directly, data_exchange hits your endpoint first

flow_tokenstring

Unique token to correlate responses. If omitted, auto-generated as '<flowId>:<uuid>' so the response can be attributed to this flow in the Flow Responses view.

bodystring required

Message body text

footerstring

Optional footer text

draftboolean

Set true to test an unpublished (DRAFT) flow

Response

Flow message sent

successboolean

messageIdstring

WhatsApp message ID (WAMID)