Zernio API Docs

Appearance

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 ​

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.

Request body ​

Content-Type: application/json

  • accountId (string) required — WhatsApp social account ID
  • to (string) required — Recipient phone number (E.164 format, e.g. +1234567890)
  • flow_id (string) required — Published flow ID
  • flow_cta (string) required — CTA button text (e.g. 'Book Now', 'Sign Up')
  • flow_action (string) (enum: navigate, data_exchange) — Action type: navigate opens a screen directly, data_exchange hits your endpoint first
  • flow_token (string) — Unique token to correlate responses. Auto-generated UUID if omitted.
  • flow_action_payload (object)
  • body (string) required — Message body text
  • header (object)
  • footer (string) — Optional footer text
  • draft (boolean) — Set true to test an unpublished (DRAFT) flow

Responses ​

200 — Flow message sent

  • success (boolean)
  • messageId (string) — WhatsApp message ID (WAMID)

400 — Validation error or missing phone number ID

401

404 — WhatsApp account not found