Send Whatsapp Flow

Send a WhatsApp Flow message (free-form, inside the 24-hour window)

The recipient is resolved from conversation_id (preferred), contact_id or recipient (phone number). Contacts without a phone number that are reachable via a WhatsApp business-scoped user ID are supported.

First-screen data is merged per key: values in data win, then the saved default data for (flow_id, screen), then (for flows built in SendSeven) the flow's send-time data sources such as the contact profile, then the flow's example data. When screen is omitted the flow's entry screen is used.

String values in data (and in saved default data) may contain contact variables, rendered per recipient before sending: {{contact.first_name}}, {{contact.last_name}}, {{contact.name}}, {{contact.email}}, {{contact.phone}}, {{contact.birthday}}, {{contact.language}} and custom fields as {{contact.custom.<key>}}. Unknown or empty variables render as an empty string. Example: "data": {"first_name": "{{contact.first_name}}"}.

Note: the flow itself must bind the value as a dynamic property (e.g. a TextBody whose text is exactly ${data.first_name}, declared in the screen's data); a ${data.x} written inside plain literal text is shown as-is by WhatsApp.

A Flow message is a free-form interactive message, so it can only be sent while the customer service window is open. Outside the window use a template with a Flow button.

Required Scopes: messages:create

Raises: 404: Channel, conversation or contact not found 400: Not a WhatsApp channel; conversation_channel_mismatch; no_whatsapp_recipient 409: CHANNEL_DISCONNECTED; conversation_owned_elsewhere (Custom Inboxes: the contact is in an ongoing conversation a colleague handles that you cannot open) 422: outside_service_window