Send Template with a Flow Button

Server URLloading...

POST

/api/v1/messages/send#template-flow

Send

Authorization

Header

Body

Send an approved template that carries a FLOW button. This is how a Flow starts a business-initiated conversation, outside the 24-hour session window.

The template and its Flow are authored in Meta Business Manager; the template reaches this account through the usual template sync. Pass the button under buttons with button_type: flow, button_payload set to your flow_token, and optionally flow_action_data for the Flow's first screen.

Both button fields are optional as far as WhatsApp is concerned — omit the button entirely and the Flow still opens, but with the token "unused", leaving you nothing to correlate the submission against.

button_index defaults to the position of the FLOW button in the approved template, so you normally do not need to set it. Sending a flow button against a template that has none returns 400.

Header Parameters

Response Body

curl -X POST "https://loading/api/v1/messages/send#template-flow" \  -H "X-AGENT-ID: agt_abc123" \  -H "Content-Type: application/json" \  -d '{    "to": "919876543210",    "message": {      "message_type": "template",      "template_name": "book_appointment",      "template_language": "en_US",      "body_variables": [        "John"      ],      "buttons": [        {          "button_type": "flow",          "button_payload": "order-8891",          "flow_action_data": {            "product": "Annual checkup"          }        }      ]    }  }'

{
  "success": true,
  "data": {
    "id": "clx9abc123def456"
  }
}

{
  "success": false,
  "message": "to field is required"
}

{
  "success": false,
  "message": "user not authenticated"
}

{
  "success": false,
  "message": "insufficient balance to send message"
}

{
  "success": false,
  "message": "template not found"
}

{
  "success": false,
  "message": "internal server error"
}