Skip to main content

Create SMS Campaign

Create a new SMS campaign to send bulk messages to your contact lists.

HTTP Request​

POST /v2/accounts/<account_sid>/message-campaigns

Request Parameters​

Required Parameters​

ParameterTypeDescription
content_typeString"static" or "dynamic"
listsArrayList SIDs — up to 5 for static, single for dynamic
channelString"SMS"
dlt_entity_idNumericDLT-approved entity ID
dlt_template_idNumericDLT-approved template ID
sender_idStringAlphabetical (transactional) or numeric (promotional)
sms_typeString"Transactional" or "Promotional"
templateStringSMS body (max 2000 characters)

Optional Parameters​

ParameterTypeDescription
nameStringCampaign name (min 3 characters)
scheduleObjectContains start_time and end_time in RFC 3339 format
status_callbackURLWebhook for campaign-level status updates
sms_status_callbackURLWebhook for individual SMS delivery updates
Dynamic Templates

For dynamic campaigns, use @@column_header syntax to insert personalized values from your contact list columns.

Schedule Object​

FieldDescription
start_timeRFC 3339 format — must be at least 10 minutes in the future
end_timeRFC 3339 format — must be at least 2 hours after start_time

Response​

{
"request_id": "745d624f47004b71bf72e6cb7d58a25b",
"http_code": 200,
"response": [
{
"status": "success",
"data": {
"sid": "909d2a2ba53ce07f3784668b938eb44914bo",
"name": "test_campaign",
"status": "scheduled",
"date_created": "2019-01-20T21:10:00+05:30"
}
}
]
}

Notes​

  • Minimum 10-minute lead time required for scheduled campaigns
  • Variables in dynamic templates must match column headers exactly
  • Default SMS capacity is 300 per minute