🚧
API token & Name space
Please refer to this page to fine the API Token and the name space: https://developer.cequens.com/reference/whatsapp-business-ver2

💡
Tip: Looking for example requests? Click the dropdown in the top-right corner of the "Request body" section to see pre-built examples you can use.

Overview

WhatsApp Flows are interactive templates that enable businesses to create multi-screen experiences within WhatsApp. Flows are ideal for:

Lead Generation: Collect customer information through forms
Appointments: Schedule bookings with date/time selection
Surveys & Feedback: Gather customer opinions and ratings.
Order Forms: Collect product selections and delivery details
Registration: Onboard new customers with guided forms
Support Tickets: Gather issue details in a structured format

✅
No 24-Hour Window Restriction
Like all template messages, Flow templates can be sent at any time, even if the customer hasn't messaged you recently.

Before You Start

Create Flow in Business Manager: Flows must be created and published in WhatsApp Business Manager
Link Flow to Template: The template must be configured with a Flow button that triggers the Flow
Test Your Flow: Always test Flows thoroughly before sending to customers
Set isTemplateWithFlow: Must be set to true for Flow templates

Flow Template Components

Flow templates can include:

Header Component (optional): Text or media header
Body Component (optional): Message text with variables
Flow Button (configured in template): Button that opens the Flow

📘
Note About Flow Buttons The Flow button is configured when you create the template in WhatsApp Business Manager. You don't need to include button components in the API request - the Flow button is automatically included with the template.

Header Component

Text Header

{
    "type": "header",
    "parameters": [
        {
            "type": "text",
            "text": "Complete Your Registration"
        }
    ]
}

Image Header

{
    "type": "header",
    "parameters": [
        {
            "type": "image",
            "image": {
                "link": "https://example.com/registration-header.jpg"
            }
        }
    ]
}

Video Header

{
    "type": "header",
    "parameters": [
        {
            "type": "video",
            "video": {
                "link": "https://example.com/intro-video.mp4"
            }
        }
    ]
}

Document Header

{
    "type": "header",
    "parameters": [
        {
            "type": "document",
            "document": {
                "link": "https://example.com/form-guide.pdf",
                "filename": "guide.pdf"
            }
        }
    ]
}

Body Component

{
    "type": "body",
    "parameters": [
        {
            "type": "text",
            "text": "John"
        },
        {
            "type": "text",
            "text": "appointment"
        }
    ]
}

200

400Bad Request