Request Body
Parameters
Name | Type | Required | Sample Value | Description |
---|---|---|---|---|
from | String | Yes | 1234567890 | Assigned 10-digit DLC number or 6-digit Short code. |
sandboxMode | Boolean | No | true | Default: false [send for production]. When true, SMS can only be sent to whitelisted numbers. |
useDraftTemplate | Boolean | No | false | Default: false . True: Send SMS using the draft template. False: Send the latest published version of SMS template. |
templateId | String | Yes | abc-template-sms-35 | Template name in the format: template-name-{type}-{id} . This value is to be copied from the IntelSend portal. |
parameters | Array | No | [ { "uid": "abc-123", "to": "13233933379", "name": "Deepak", "address": "1234" }, { "uid": "xyz-123", "to": "19495790525", "name": "Jim", "address": "1234" } ] | Array of objects with key-value pairs. The keys correspond to the variable names in the SMS template, and the values are the data to replace each variable. |
sendAt | DateTime | No | 2024-11-01 11:00:00 | Datetime format: YYYY-MM-DD HH:mm:ss in UTC timezone. Default is the current datetime. |
uid | String | Yes | abc-123 | Limit: 40 characters. Unique identifier used for tracking. This uid will be returned in the response. |
programId | Integer | Yes | 12345 | Limit: 6 digits. Used to bundle multiple requests under a single programId for reporting and billing purposes. |
checkOptOut | Boolean | No | true | Default: true . Checks if the number is opted out of the short code. If false, bypasses the opt-out check for the short code. Long code opt-outs are managed by carriers and cannot be bypassed. |
Refer to the Examples for sample requests.