Send Template with Header Variables + Attachment

Send a template message with header variables and a media header attachment.

Authorization

ApiKeyAuth

X-API-Key<token>

API key from your dashboard (Settings > API Keys)

In: header

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.

to*string

Recipient phone number with country code

scheduleTime?string

Optional. Format DD-MM-YYYY:HH-MM, interpreted in IST (Asia/Kolkata). If provided, the message is held until this time and dispatched by a cron job (runs every 2 minutes). Must be in the future and within 30 days. The wallet is charged immediately at request time. Response shape becomes {id, scheduledAt} instead of the usual session-details payload.

Match^\d{2}-\d{2}-\d{4}:\d{2}-\d{2}$

message*

Response Body

`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 + Attachment

Authorization

Header Parameters

Request Body

Response Body

201application/json

400application/json

401application/json

402application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`