API Reference

Send Flows Template Message

Send a template message that opens a WhatsApp Flow. You can pass an optional flow_token and initial data payload (flow_action_data) to the flow.

Example Request Body

{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "to": "PHONE_NUMBER",
  "type": "template",
  "template": {
    "name": "TEMPLATE_NAME",
    "language": {
      "code": "LANGUAGE_AND_LOCALE_CODE"
    },
    "components": [
      {
        "type": "button",
        "sub_type": "flow",
        "index": "0",
        "parameters": [
          {
            "type": "action",
            "action": {
              "flow_token": "FLOW_TOKEN",
              "flow_action_data": {
                "key": "value"
              }
            }
          }
        ]
      }
    ]
  }
}
Language
Click Try It! to start a request and see the response here!