POST
/
messages
/
interactive
/
send-buttons

Sends a message with up to 3 reply buttons. This is supported on WhatsApp, Z-API, and ZapperHUB channels.

Authentication: Requires a valid API key or session. Pass as Authorization: Bearer <api_key>.

Request Body

Required Parameters

  • agentId: The ID of the agent sending the message.
  • conversationId: The ID of the conversation.
  • body_text: The main text of the message.
  • button_1_id: Unique ID for the first button.
  • button_1_title: Display text for the first button.

Optional Parameters

  • header_text: Text to be displayed in the header of the message.
  • footer_text: Text to be displayed in the footer of the message.
  • button_2_id: Unique ID for the second button.
  • button_2_title: Display text for the second button.
  • button_3_id: Unique ID for the third button.
  • button_3_title: Display text for the third button.

Limits

  • Maximum 3 buttons per message (Meta API limit). Sending 4+ returns error code 131009.
  • Button titles should be kept short (20 characters max recommended by Meta).

Example

{
  "agentId": "agent-123",
  "conversationId": "conv-456",
  "header_text": "Select an option",
  "body_text": "How can we help you today?",
  "footer_text": "ChatVolt Support",
  "button_1_id": "btn_sales",
  "button_1_title": "Sales",
  "button_2_id": "btn_support",
  "button_2_title": "Support"
}

Error Responses

HTTP StatusMeaning
400Invalid request body
401Invalid or missing API key
403Agent does not belong to your organization
404Conversation or agent not found
500WhatsApp API error (e.g., more than 3 buttons, invalid payload)

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
agentId
string
required

The ID of the agent sending the message.

conversationId
string
required

The ID of the conversation.

header_text
string

Optional header text.

body_text
string
required

The main message body.

footer_text
string

Optional footer text.

button_1_id
string
required

ID for the first button.

button_1_title
string
required

Label for the first button.

button_2_id
string

ID for the second button.

button_2_title
string

Label for the second button.

button_3_id
string

ID for the third button.

button_3_title
string

Label for the third button.