Campaigns Intro
The IntelSend Campaign API lets you manage Email, SMS, and Voice campaigns in a single flow:
Create → Get → Build → Send 🚀
Campaign Lifecycle
- Create
- Get
- Build
- Send
Step 1: Create a Campaign
Start by creating a campaign with your templates and contact lists.
- Request
- Response
curl --location 'https://beta.intelsend.com/api/campaign' \\
--header 'x-user-id: 648b80839b30ddb88cdbab11' \\
--header 'Content-Type: application/json' \\
--header 'Cookie: __Secure-next-auth.session-token=<YOUR_SESSION_TOKEN>' \\
--data-raw '{
"campaignId": null,
"name": "Campaign Template",
"settings": {
"email": {
"fromEmail": "info@intelsend.com",
"templateId": "66d845e99bb64dbbd0d449d8",
"version": 1
},
"sms": {
"shortCode": "9498671145",
"templateId": "6708a567654ca1d854afa3bd",
"version": 1
},
"voice": {
"callerId": "9498671008",
"templateId": "67077eb17f4a5560aa9c3ea8",
"version": 1
}
},
"channel": ["email","sms","voice"],
"contactListId": [
"687a0f67137b4868f1b1eaea",
"6889fa1e53d9e06f64c13d59",
"683d77584efab5b960439970"
]
}'
{
"result":"success"
}
Step 2: Get Campaigns
Retrieve your campaigns with filters (status, channel, dates).
- Request
- Response
curl --location 'https://beta.intelsend.com/api/campaign?page=1&limit=10' \\
--header 'x-user-id: 648b80839b30ddb88cdbab 11'
{
"result": [
{
"campaignId": "68b0b5ccfcccb5cfc3b1f4eb",
"name": "campaign Template",
"channel": ["email","sms","voice"],
"status": "SENDING",
"settings": { ... },
"contactListId": [
{"_id": "687a0f67137b4868f1b1eaea", "name": "email-3"},
{"_id": "6889fa1e53d9e06f64c13d59", "name": "sms 1"},
{"_id": "683d77584efab5b960439970", "name": "Voice-1"}
],
"changeLog": [
{"status": "DRAFT", "updateAt": "2025-08-28T20:02:20.603Z"},
{"status": "BUILD", "updateAt": "2025-08-28T20:05:04.662Z"},
{"status": "SENDING", "updateAt": "2025-08-28T20:06:23.241Z"}
],
"createdAt": "2025-08-28T20:02:20.600Z",
"stats": {
"result": [{"_id": {"status": "PENDING"}, "count": 5}],
"initContacts": [
{"name": "email-3", "contacts": 3},
{"name": "sms 1", "contacts": 1},
{"name": "Voice-1", "contacts": 1}
]
}
},
...
],
"meta": { "count": 19, "page": 1, "limit": 10 }
}
Step 3: Build Campaign
Building compiles your campaign and prepares it for sending.
- Request
- Response
curl --location --request PUT 'https://beta.intelsend.com/api/campaign/68b0b5ccfcccb5cfc3b1f4eb/build' \\
--header 'Cookie: __Secure-next-auth.session-token=<YOUR_SESSION_TOKEN>'
{ "result": "success" }
Step 4: Send Campaign
After building, send your campaign live 🚀
- Request
- Response
curl --location --request PUT 'https://beta.intelsend.com/api/campaign/68b0b5ccfcccb5cfc3b1f4eb/send' \\
--header 'Cookie: __Secure-next-auth.session-token=<YOUR_SESSION_TOKEN>'
{
"result": "success",
"response": "Successfully processed messages."
}
Important
- Always call APIs in order: create → build → send.
- Use correct
templateIdandcontactListIdvalues. - Deleted or invalid templates will cause campaign failures.
✅ You now have a full campaign lifecycle reference with real responses.