WhatsApp Flows

WhatsApp Flows

Publish a WhatsApp flow

post

Publishes a WhatsApp flow using the provided flow ID.

Path parameters

whatsappBusinessAccountintegerRequired

The ID of the WhatsApp Business Account

flowIdstringRequired

The ID of the flow to be published

Responses

200

Flow published successfully

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

post

/api/whatsapp/{whatsappBusinessAccount}/flows/{flowId}/publish

HTTPcURLJavaScriptPython

POST /api/whatsapp/{whatsappBusinessAccount}/flows/{flowId}/publish HTTP/1.1
Host: 
Accept: */*

{
  "success": true,
  "message": "Flow published successfully",
  "data": {}
}

Send an interactive flow message

post

Send an interactive flow message via WhatsApp API.

Body

application/json

tostringOptional

Recipient's phone number

flow_idstringOptional

Unique Flow ID provided by WhatsApp

header_textstringOptional

Dynamic text for the header

body_textstringOptional

Dynamic text for the body

footer_textstringOptional

Dynamic text for the footer

flow_ctastringOptional

Dynamic text for the CTA button

screenstringOptional

Screen ID for the first screen of the Flow

Responses

200

Successful operation

application/json

400

Bad Request

401

Unauthorized

500

Internal Server Error

post

/api/whatsapp/{whatsappBusinessAccount}/flows/send

HTTPcURLJavaScriptPython

POST /api/whatsapp/{whatsappBusinessAccount}/flows/send HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 125

{
  "to": "text",
  "flow_id": "text",
  "header_text": "text",
  "body_text": "text",
  "footer_text": "text",
  "flow_cta": "text",
  "screen": "text"
}

{
  "success": true,
  "message": "text",
  "data": {}
}

Retrieve a list of Flows

get

Retrieves a list of Flows under a WhatsApp Business Account

Responses

200

Successful operation

application/json

401

Unauthorized

500

Internal Server Error

get

/api/whatsapp/{whatsappBusinessAccount}/flows

HTTPcURLJavaScriptPython

GET /api/whatsapp/{whatsappBusinessAccount}/flows HTTP/1.1
Host: 
Accept: */*

{
  "data": [
    {
      "id": "text",
      "name": "text",
      "status": "text",
      "categories": [
        "text"
      ],
      "validation_errors": [
        "text"
      ]
    }
  ],
  "paging": {
    "cursors": {
      "before": "text",
      "after": "text"
    }
  }
}

Create a new Flow

post

Creates a new Flow under a WhatsApp Business Account

Body

multipart/form-data

namestringOptional

Name of the Flow

Example: Customer Support Flow

clone_flow_idstringOptional

ID of the existing Flow to clone

Example: original-flow-id

endpoint_uristringOptional

Endpoint URI for the Flow

Example: https://example.com

Responses

200

Flow created successfully

application/json

401

Unauthorized

500

Internal Server Error

post

/api/whatsapp/{whatsappBusinessAccount}/flows

HTTPcURLJavaScriptPython

POST /api/whatsapp/{whatsappBusinessAccount}/flows HTTP/1.1
Host: 
Content-Type: multipart/form-data
Accept: */*
Content-Length: 127

{
  "name": "Customer Support Flow",
  "categories": [
    "OTHER"
  ],
  "clone_flow_id": "original-flow-id",
  "endpoint_uri": "https://example.com"
}

{
  "id": "text"
}

Delete WhatsApp Flow

delete

Path parameters

whatsappBusinessAccountintegerRequired

The ID of the WhatsApp Business Account

Query parameters

flowIdstringRequired

The ID of the flow to be deleted

Responses

200

Flow deleted successfully

application/json

401

Failed to get a valid access token

application/json

500

Internal Server Error

application/json

delete

/api/whatsapp/{whatsappBusinessAccount}/flows

HTTPcURLJavaScriptPython

DELETE /api/whatsapp/{whatsappBusinessAccount}/flows?flowId=text HTTP/1.1
Host: 
Accept: */*

{
  "message": "Flow deleted successfully"
}

Retrieve Flow Details

get

Returns detailed information about a specific Flow.

Path parameters

flowIdstringRequired

The unique ID of the Flow.

Responses

200

Successful Response

application/json

400

Bad Request

401

Unauthorized

404

Not Found

get

/api/whatsapp/{whatsappBusinessAccount}/flows/{flowId}

HTTPcURLJavaScriptPython

GET /api/whatsapp/{whatsappBusinessAccount}/flows/{flowId} HTTP/1.1
Host: 
Accept: */*

{
  "id": "text",
  "name": "text",
  "status": "text",
  "categories": [
    "text"
  ],
  "validation_errors": [
    {
      "error": "text",
      "error_type": "text",
      "message": "text",
      "line_start": 1,
      "line_end": 1,
      "column_start": 1,
      "column_end": 1
    }
  ],
  "json_version": "text",
  "data_api_version": "text",
  "endpoint_uri": "text",
  "preview": {
    "preview_url": "text",
    "expires_at": "2025-12-18T09:16:25.660Z"
  },
  "whatsapp_business_account": {},
  "application": {},
  "health_status": {
    "can_send_message": "text",
    "entities": [
      {
        "entity_type": "text",
        "id": "text",
        "can_send_message": "text",
        "errors": [
          {
            "error": "text",
            "error_type": "text",
            "message": "text",
            "line_start": 1,
            "line_end": 1,
            "column_start": 1,
            "column_end": 1
          }
        ],
        "additional_info": [
          "text"
        ]
      }
    ]
  },
  "json_content": [
    "text"
  ]
}

Update Flow

post

Updates an existing Flow.

Path parameters

flowIdstringRequired

The unique ID of the Flow.

Body

application/json

namestringOptional

Flow name

categoriesstring[]Optional

Flow categories

endpoint_uristringOptional

Endpoint URI for the flow

Responses

200

Flow updated successfully

application/json

400

Bad Request

401

Unauthorized

404

Not Found

post

/api/whatsapp/{whatsappBusinessAccount}/flows/{flowId}

HTTPcURLJavaScriptPython

POST /api/whatsapp/{whatsappBusinessAccount}/flows/{flowId} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "name": "text",
  "categories": [
    "text"
  ],
  "endpoint_uri": "text"
}

{
  "id": "text",
  "name": "text",
  "status": "text",
  "categories": [
    "text"
  ],
  "validation_errors": [
    {
      "error": "text",
      "error_type": "text",
      "message": "text",
      "line_start": 1,
      "line_end": 1,
      "column_start": 1,
      "column_end": 1
    }
  ],
  "json_version": "text",
  "data_api_version": "text",
  "endpoint_uri": "text",
  "preview": {
    "preview_url": "text",
    "expires_at": "2025-12-18T09:16:25.660Z"
  },
  "whatsapp_business_account": {},
  "application": {},
  "health_status": {
    "can_send_message": "text",
    "entities": [
      {
        "entity_type": "text",
        "id": "text",
        "can_send_message": "text",
        "errors": [
          {
            "error": "text",
            "error_type": "text",
            "message": "text",
            "line_start": 1,
            "line_end": 1,
            "column_start": 1,
            "column_end": 1
          }
        ],
        "additional_info": [
          "text"
        ]
      }
    ]
  },
  "json_content": [
    "text"
  ]
}

Upload Flow JSON Asset

post

Uploads a flow JSON file to the specified flow ID. The file must be a valid JSON and the file name must match the provided name ending with .json.

Body

multipart/form-data

flow_idstringOptional

The ID of the flow to upload the JSON file to.

filestring · binaryOptional

The JSON file to upload. The file content must be valid JSON.

Responses

200

Uploaded Successfully.

application/json

400

Validation Error(s) or Upload Failed.

application/json

post

/api/whatsapp/{whatsappBusinessAccount}/flows/upload-flow-json

HTTPcURLJavaScriptPython

POST /api/whatsapp/{whatsappBusinessAccount}/flows/upload-flow-json HTTP/1.1
Host: 
Content-Type: multipart/form-data
Accept: */*
Content-Length: 34

{
  "flow_id": "text",
  "file": "binary"
}

{
  "success": true,
  "message": "Uploaded Successfully",
  "validations_errors": [
    {
      "error": "text",
      "error_type": "text",
      "message": "text",
      "line_start": 1,
      "line_end": 1,
      "column_start": 1,
      "column_end": 1
    }
  ]
}

Deprecate a WhatsApp flow

post

Deprecate a WhatsApp flow by its ID

Authorizations

apiAuth

Path parameters

whatsappBusinessAccountstringRequired

WhatsApp Business Account ID

flowIdstringRequired

Flow ID to be deprecated

Responses

200

Flow deprecated successfully

application/json

401

Failed to get a valid access token

application/json

500

Internal Server Error

application/json

post

/whatsapp/{whatsappBusinessAccount}/flows/{flowId}/deprecate

HTTPcURLJavaScriptPython

POST /whatsapp/{whatsappBusinessAccount}/flows/{flowId}/deprecate HTTP/1.1
Host: 
Accept: */*

{
  "message": "Flow deprecated successfully"
}