Message templates

Available methods

All available methods for resource Message templates.

HTTP method Endpoint Description
[badge-blue GET] /message-templates Get information about all message templates
[badge-blue GET] /message-templates/{message_template_id} Get information about an message-template


Get all message templates

Get information about message templates as a list of all message templates
[badge-blue GET] /message-templates

Query string

Parameter name Type Description Mandatory (Yes/No)
count integer The number of records to return.
Default value is 100.
No
offset integer The number of records from a collection to skip.
Default value is 0.
No
sort_field string One of the query string parameters for sorting.
Response is sorted by the specified field.
No
sort_direction string Direction of sorting the response list.
Possible values are: ASC / DESC
No
name string Name for the message template No

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
message_templates MessageTemplate[] List of all message templates
total_items integer Count of all found message templates


Get an message template

Get information about a specific message template
[badge-blue GET] /message-templates/{message_template_id}

Path parameters

Parameter name Type Description
message_template_id string The unique id for the message template

Response

Status code: 200 OK
Output structure : MessageTemplate