Send CTA

Sends a message with a URL button (Call to Action). This is supported on WhatsApp and Z-API 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.
• conversationId: The ID of the conversation.
• body_text: Main message body.
• button_display_text: Label for the URL button.
• button_url: The URL to open (must be a valid URL with https://).

​

Optional Parameters

• header_text: Header text.
• footer_text: Footer text.

​

Example

{
  "agentId": "agent-123",
  "conversationId": "conv-456",
  "header_text": "Check Us Out",
  "body_text": "Visit our website for more information.",
  "footer_text": "We look forward to seeing you!",
  "button_display_text": "Open Website",
  "button_url": "https://chatvolt.ai"
}

​

Error Responses