For the complete documentation index, see llms.txt. This page is also available as Markdown.

Scheduled Messages

Scheduled Messages Management

Get Scheduled Message

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
scheduledMessageIdstringRequired
Responses
200

Success

application/json
get/scheduled/{scheduledMessageId}

Update Scheduled Message

patch
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
scheduledMessageIdstringRequired
Body
messagestringOptional
numberIdsnumber[]Optional
groupIdsnumber[]Optional
allSubscribersbooleanOptional
excludedGroupIdsnumber[]Optional
scheduledDatestringOptional
imagestring · nullableOptional
repeatMessagenumberOptional
repeatDaysnumber[]Optional
repeatMonthTypestring · nullableOptional
headerstringOptional
footerstringOptional
templateIdnumberOptional
Responses
200

Success

application/json
patch/scheduled/{scheduledMessageId}

Delete Scheduled Message

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
scheduledMessageIdstringRequired
Body
isMMSbooleanOptional
Responses
200

Success

application/json
post/scheduled/{scheduledMessageId}

List Scheduled Messages

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
pagenumberOptional
pageSizenumberOptional
sortDirectionstring · enumOptionalPossible values:
querystringOptional
sortBystringOptional
Responses
200

Success

application/json
get/scheduled

Get Scheduled Message Calendar

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
yearstringRequired
monthstringRequired
Query parameters
querystringOptional
Responses
200

Success

application/json
get/scheduled/calendar/{year}/{month}

Get Scheduled Message Recipients

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
scheduledMessageIdstringRequired
Query parameters
pagenumberOptional
pageSizenumberOptional
sortDirectionstring · enumOptionalPossible values:
querystringOptional
sortBystringOptional
Responses
200

Success

application/json
get/scheduled/{scheduledMessageId}/recipients

Delete Scheduled Messages for Number

delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
numberstringRequired
Responses
200

Success

application/json
delete/scheduled/number/{number}

Last updated

Was this helpful?