Send Template in a Campaign

Server URLloading...

POST

/api/v1/messages/send#template-campaign

Send

Authorization

Header

Body

Group API template sends into a campaign by passing campaign_id, any string you choose (an order batch, a date, your own campaign key). The first send with a new campaign_id creates a campaign in the dashboard's Campaigns list; every later send with the same id joins it. It gets the usual campaign reporting: sent, delivered, read, failed, button replies and the recipient list.

• campaign_name names the campaign when it is created (default Custom campaign) and is ignored afterwards.
• Template messages only.
• A campaign is locked to the template and WhatsApp number of its first send. A different template under the same id returns 400 INVALID_CAMPAIGN; use a new id instead.
• Quick-reply buttons get a campaign payload (bc:<id>:<index>) so replies are attributed to the campaign, unless you pass that button yourself.
• Billing is unchanged: each message is charged when sent, exactly like any API send.
• The id is echoed back as campaign_id in the response and in message.report webhooks.

Also works on POST /api/v1/messages/send/bulk (one campaign for the whole batch) and the GET send endpoint (campaignId / campaignName query parameters). Dashboard campaigns and API campaign ids are separate.

Header Parameters

Response Body

curl -X POST "https://loading/api/v1/messages/send#template-campaign" \  -H "X-AGENT-ID: agt_abc123" \  -H "Content-Type: application/json" \  -d '{    "to": "919876543210",    "campaign_id": "diwali-2026",    "campaign_name": "Diwali offers",    "message": {      "message_type": "template",      "template_name": "diwali_offer",      "template_language": "en_US",      "body_variables": [        "John"      ]    }  }'

{
  "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"
}