Schedule SMS session | Atlas

api-keystring

Your Atlas API key. Get it from the Atlas Portal under Settings > API Keys.

campaignIdstringRequired

This endpoint expects an object.

customerPhoneNumberstringRequired

Contact phone number in E.164 format.

customerNamestringRequired

Contact first name.

customerLastNamestringOptional

Contact last name.

customerInfostringOptional

Key-value pairs of additional contact information (e.g. “EventType=Wedding\nEmail=user@example.com”).

Key-value pairs of additional contact information (e.g. "EventType=Wedding\nEmail=user@example.com").

customMessagestringOptional

Custom first message to send instead of the campaign default.

scheduledDatedatetimeOptional

ISO 8601 datetime to schedule the message. If omitted the message is sent immediately.

attachmentslist of stringsOptional

Up to 3 public HTTPS URLs for image or video attachments (MMS). Each URL must use HTTPS and not exceed 256 characters.

Session scheduled

campaignIdstring

contactPhoneNumberstring

sessionIdstring

messageIdstring

scheduledDatedatetime

sequenceNumberinteger

400

Bad Request Error

500

Internal Server Error

$	curl -X POST https://api.youratlas.com/v1/api/campaign-chat/campaignId/sessions/sms/schedule \
>	-H "api-key: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"customerPhoneNumber": "+14155552671",
>	"customerName": "Emily"
>	}'