Scheduled Messages
Scheduled Messages Management
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
scheduledMessageIdstringRequired
Responses
200
Success
application/json
400
BadRequestError
application/json
401
UnauthorizedError
application/json
403
ForbiddenError
application/json
500
InternalServerError
application/json
get
/scheduled/{scheduledMessageId}Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
scheduledMessageIdstringRequired
Body
messagestringOptional
numberIdsnumber[]Optional
groupIdsnumber[]Optional
allSubscribersbooleanOptional
scheduledDatestringOptional
imagestring · nullableOptional
repeatMessagenumberOptional
repeatDaysnumber[]Optional
repeatMonthTypestring · nullableOptional
excludedGroupIdsnumber[]Optional
headerstringOptional
footerstringOptional
isMMSbooleanOptional
templateIdnumberOptional
longcodeIdnumberOptional
customRepeatFrequencyTypenumber · nullableOptional
customRepeatFrequencynumber · nullableOptional
customRepeatDaysnumber[]Optional
customEndMessageTypenumber · nullableOptional
customEndMessageDatestring · nullableOptional
customEndMessageOccurrencesnumber · nullableOptional
Responses
200
Success
application/json
400
BadRequestError
application/json
401
UnauthorizedError
application/json
403
ForbiddenError
application/json
500
InternalServerError
application/json
patch
/scheduled/{scheduledMessageId}Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
scheduledMessageIdstringRequired
Body
isMMSbooleanOptional
skippedAtone ofOptional
string · date-timeOptional
stringOptional
Responses
200
Success
application/json
400
BadRequestError
application/json
401
UnauthorizedError
application/json
403
ForbiddenError
application/json
500
InternalServerError
application/json
post
/scheduled/{scheduledMessageId}Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
pagenumberOptional
pageSizenumberOptional
sortBystringOptional
sortDirectionstring · enumOptionalPossible values:
querystringOptional
Responses
200
Success
application/json
400
BadRequestError
application/json
401
UnauthorizedError
application/json
403
ForbiddenError
application/json
500
InternalServerError
application/json
get
/scheduledAuthorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
yearstringRequired
monthstringRequired
Query parameters
querystringOptional
Responses
200
Success
application/json
400
BadRequestError
application/json
401
UnauthorizedError
application/json
403
ForbiddenError
application/json
500
InternalServerError
application/json
get
/scheduled/calendar/{year}/{month}Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
scheduledMessageIdstringRequired
Query parameters
pagenumberOptional
pageSizenumberOptional
sortBystringOptional
sortDirectionstring · enumOptionalPossible values:
querystringOptional
Responses
200
Success
application/json
400
BadRequestError
application/json
401
UnauthorizedError
application/json
403
ForbiddenError
application/json
500
InternalServerError
application/json
get
/scheduled/{scheduledMessageId}/recipientsAuthorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
numberstringRequired
Responses
200
Success
application/json
400
BadRequestError
application/json
401
UnauthorizedError
application/json
403
ForbiddenError
application/json
500
InternalServerError
application/json
delete
/scheduled/number/{number}Last updated
Was this helpful?