General Documentation
Agents
Agent Executions
Test Suites
Projects
WhatsApp Conversations
Customers
WhatsApp Configs
Agent Test Chats
Conversation Assignments
WhatsApp Templates
WhatsApp Contact Notes
Agent Snapshots
WhatsApp Templates
Send a WhatsApp template message
Sends a WhatsApp template message to a specified phone number
POST
/
whatsapp_templates
/
{template_id}
/
send_template
Copy
curl --request POST \
--url https://app.kapso.ai/api/v1/whatsapp_templates/{template_id}/send_template \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '{
"template": {
"phone_number": "+123456789012",
"template_parameters": [
"John Smith",
"Tomorrow at 2 PM"
],
"header_type": "image",
"header_params": "https://example.com/header-image.jpg",
"header_filename": "invoice.pdf",
"whatsapp_config_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}'
Copy
{
"status": "success",
"message": "Template message sent successfully",
"template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"template_name": "<string>",
"response": {}
}
Authorizations
API key required for all endpoints
Path Parameters
Body
application/json
Response
200
application/json
Template message sent successfully
The response is of type object
.
Copy
curl --request POST \
--url https://app.kapso.ai/api/v1/whatsapp_templates/{template_id}/send_template \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '{
"template": {
"phone_number": "+123456789012",
"template_parameters": [
"John Smith",
"Tomorrow at 2 PM"
],
"header_type": "image",
"header_params": "https://example.com/header-image.jpg",
"header_filename": "invoice.pdf",
"whatsapp_config_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}'
Copy
{
"status": "success",
"message": "Template message sent successfully",
"template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"template_name": "<string>",
"response": {}
}
Assistant
Responses are generated using AI and may contain mistakes.