WhatsApp

Get Whatsapp Flow Details

Get detailed information about a specific WhatsApp Flow

Returns the flow's screens (with input fields, the raw data declaration as data_schema, and whether the screen is terminal), the entry screen, whether the flow is static (no data endpoint — first-screen data must be sent with the message), and the saved default data per screen.

The flow JSON is cached for a few minutes; pass refresh=true to re-read it.

Required Scopes: channels:read

Raises: 404: Channel not found or access denied 400: Channel is not a WhatsApp channel

get/api/v1/whatsapp/channels/{channel_id}/flows/{flow_id}

Request

  • Base URL: https://api.sendseven.com
  • URL: https://api.sendseven.com/api/v1/whatsapp/channels/{channel_id}/flows/{flow_id}
  • Auth: HTTP bearer

Path parameters

channel_idstring required
flow_idstring required

Query parameters

refreshboolean

Bypass the cached flow JSON and re-download it from Meta

Response

Successful Response

successboolean required
variablesstring[]

Variables that can be passed via data parameter

entry_screenstring nullable

Screen the flow opens on

is_staticboolean

True when the flow has no data endpoint (first-screen data must be sent with the message)

flow_json_availableboolean

Whether the flow JSON could be read

defaultsobject

Saved default data per screen id: {screen_id: data}

errorstring nullable

Changes

No recorded changes to this operation across all 3 revisions of this API.