Send Template with Header Variables + Attachment
Send a template message with header variables and a media header attachment.
Authorization
ApiKeyAuth API key from your dashboard (Settings > API Keys)
In: header
Header Parameters
Optional. Attribute this send to a specific agent, overriding the agent bound to the API key. The agent must belong to your account and be active (role AGENT, parent = your account) — otherwise the request returns 400. Drives customer assignment, agent allotment limits, and the wallet ledger entry.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://loading/api/v1/messages/send#template-header-vars-attachment" \ -H "X-AGENT-ID: agt_abc123" \ -H "Content-Type: application/json" \ -d '{ "to": "919876543210", "message": { "message_type": "template", "template_name": "receipt_with_doc", "template_language": "en_US", "header_variables": [ "TXN-98765" ], "attachments": { "type": "document", "attachment": "https://example.com/receipt.pdf", "file_name": "Receipt-TXN-98765.pdf" } } }'{
"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"
}Send Template with Header Variables POST
Send a template message with dynamic header variables. Header variables are substituted into the template header text.
Send Bulk Message POST
Send the same message to multiple recipients (max 50). The message body follows the same structure as single message operations — specify the `message_type` and its required fields. Recipients are deduplicated automatically. Empty phone numbers are ignored.