You can create and manage a multitude of different messages to deliver effective content to customers within a personalized omnichannel marketing communication in the CareCloud platform. You get all message template details via this resource.
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 information about message templates as a list of all message templates
[badge-blue GET] /message-templates
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 |
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 https://<projectURL>/rest-api/enterprise-interface/v1.0/message-templates?name=20130319_Hotels_newsletter_EN&count=3
Content-Type: application/json
Accept-Language: cs, en-gb;q=0.8
Authorization: Basic ZW50ZlcmZhY2U6YmVlZDA2ZjBmYTerEyZjA0NDEwOWIzNzk2ZjM4ODEyZTMjcyYzQ3N2M5NDE5ZjY2NzMwZmRjN2RmYw==
HTTP/1.1 200 OK
Date: Tue, 29 Sep 2020 14:22:26 GMT
Content-Type: application/json; charset=utf-8
{
"data": {
"message_templates": [
{
"message_template_id": "82de12eb8b138791e678fd11c3",
"consent_free_template": false,
"subject": "Hotels",
"sender": "<info@crmcarecloud.com>",
"name": "PF Hotels",
"message_template_group_id": 1,
"comunication_channel_id": 1,
"template_data": [],
"last_change": "2016-05-04 11:29:10"
},
{
"message_template_id": "82db62087b0f79a6e14e5747e7",
"consent_free_template": false,
"subject": null,
"sender": null,
"name": "Your New Voucher!",
"message_template_group_id": 1,
"comunication_channel_id": 2,
"template_data": [],
"last_change": "2020-02-13 14:48:34"
}
],
"total_items": 1094
}
}
Get information about a specific message template
[badge-blue GET] /message-templates/{message_template_id}
Parameter name | Type | Description |
---|---|---|
message_template_id | string | The unique id for the message template |
Status code: 200 OK
Output structure : MessageTemplate
GET https://<projectURL>/rest-api/enterprise-interface/v1.0/message-templates/82de12eb8b138791e678fd11c3
Content-Type: application/json
Accept-Language: cs, en-gb;q=0.8
Authorization: Basic ZW50ZXJwcmlzZVlcmZhY2U6YmVlmYTrtEyZjAOWIzNzk2ZjM4ODEyZTIxjcyYzQ3N2M5NDE5ZjY2NzMwZmRjN2RmYw==
HTTP/1.1 200 OK
Date: Tue, 29 Sep 2020 14:23:55 GMT
Content-Type: application/json; charset=utf-8
{
"data": {
"message_template_id": "82de12eb8b138791e678fd11c3",
"consent_free_template": false,
"subject": "Hotels",
"sender": "<info@crmcarecloud.com>",
"name": "Náezv",
"message_template_group_id": 1,
"comunication_channel_id": 1,
"template_data": [],
"last_change": "2016-05-04 11:29:10"
}
}