Skip to main content

Request Body

Parameters

NameTypeRequiredSample ValueDescription
fromStringYes1234567890Assigned 10-digit DLC number or 6-digit Short code.
sandboxModeBooleanNotrueDefault: false [send for production]. When true, SMS can only be sent to whitelisted numbers.
useDraftTemplateBooleanNofalseDefault: false. True: Send SMS using the draft template. False: Send the latest published version of SMS template.
templateIdStringYesabc-template-sms-35Template name in the format: template-name-{type}-{id}. This value is to be copied from the IntelSend portal.
parametersArrayNo[ { "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.
sendAtDateTimeNo2024-11-01 11:00:00Datetime format: YYYY-MM-DD HH:mm:ss in UTC timezone. Default is the current datetime.
uidStringYesabc-123Limit: 40 characters. Unique identifier used for tracking. This uid will be returned in the response.
programIdIntegerYes12345Limit: 6 digits. Used to bundle multiple requests under a single programId for reporting and billing purposes.
checkOptOutBooleanNotrueDefault: 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.