v1

latestOpenAPI 3.0.02026-07-2491237338.9 KB

WhatsApp Flows

Retrieve a flow

Retrieves a WhatsApp Flow's details.

get/whatsapp/flows/{flowId}

Path parameters

flowIdstring required

Example:flow-1

Flow ID.

Response

Successfully retrieved the flow.

idstring

Flow ID.

namestring

Flow name.

status'DRAFT' | 'PUBLISHED' | 'DEPRECATED'

Status of the WhatsApp Flow.

DRAFT: The Flow is in draft state and can be modified.
PUBLISHED: The Flow is published and cannot be modified.
DEPRECATED: The Flow is deprecated and cannot be used.

categoriesWhatsappFlowCategory[]

Flow categories.

jsonVersionstring

Version of the Flow JSON structure.

dataApiVersionstring

Version of the Data API.

endpointUristring

The endpoint URI for the Flow.

Example response

{
  "id": "flow-1",
  "name": "My first flow",
  "whatsappBusinessAccount": {
    "id": "463056733559090",
    "name": "Waba - Name",
    "currency": "EUR"
  },
  "validationErrors": [
    {
      "error": "INVALID_PROPERTY_VALUE",
      "errorType": "FLOW_JSON_ERROR",
      "message": "Invalid value found for property 'type'.",
      "lineStart": 10,
      "lineEnd": 10,
      "columnStart": 21,
      "columnEnd": 34,
      "pointers": [
        {
          "lineStart": 10,
          "lineEnd": 10,
          "columnStart": 21,
          "columnEnd": 34,
          "path": "screens[0].layout.children[0].type"
        }
      ]
    }
  ],
  "jsonVersion": "3.0",
  "dataApiVersion": "3.0",
  "endpointUri": "https://example.com/flow-endpoint"
}