Templates

Create Template

post

Required Fields: message

Defaults: isMMS will default to false and a regular sms template will be created unless an attachment is provided. If name is not provided, up to the first 32 characters of the message will be used as the name.

undefined

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
namestringOptional
messagestringRequired
attachmentstringOptional
isMMSbooleanOptional
Responses
chevron-right
200

Success

application/json
post
/templates

Get Template

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Query parameters
isMMSstringRequired
Responses
chevron-right
200

Success

application/json
get
/templates/{id}

Update Template

patch
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Body
namestringOptional
messagestringOptional
attachmentstringOptional
isMMSbooleanOptional
updateAsMMSbooleanOptional
Responses
chevron-right
200

Success

application/json
patch
/templates/{id}

Delete Template

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Body
isMMSbooleanRequired
Responses
chevron-right
200

Success

application/json
post
/templates/{id}

List Templates

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

Success

application/json
get
/templates

Last updated

Was this helpful?