Get all message templates

get https://{project_url}/webservice/rest-api/{api_interface}/{version}/message-templates

Get information about message templates as a list of all message templates.

Query Params

count

integer

≥ 1

Defaults to 100

The number of records to return in API response.
⚠️ We recommended adjust the batch size based on processing time. Depending on the response time of the request. Default value of 100 records is used if count parameter is not set.

offset

integer

≥ 0

Defaults to 0

The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.

sort_field

string

Name of the sorting parameter. You can sort by any of the first level parameters from the resource response. Response is sorted by the specified field.

sort_direction

string

Direction of sorting the response list.

name

string

Search record by name or a part of the name.

communication_channel_id

string

The unique ID of the communication channel. List of values is available in resource GET /communication-channels.

Headers

Accept-Language

string

Defaults to cs, en-gb;q=0.8

The unique ID of the language code by ISO 639-1.

Responses

Response body

object

data

object

message_templates

array of objects

List of all message templates.

message_templates

object

message_template_id

string

The unique ID of the message_template.

consent_free_template

boolean

If true, customer can receive message without any consent(GDPR, etc.).

true

subject

string

required

Subject of the message template. Mandatory only in case of email template.

sender

string

required

Sender of the message template.

name

string

required

Name of the message template.

message_template_group_id

integer

required

The unique ID of the message template group. Possible values are: 1 - newsletter template / 2 - system template (registration message, order summary message, etc.) / 3 - transactional communication (for hotel, traveling,...)

1 2 3

communication_channel_id

integer

required

The unique ID of the communication channel. Possible values are: 1 - email / 2 - SMS / 4 - PUSH notification (Apple or Google)/ 5 - internal system notification / 9 - Viber messages

1 2 4 5 9

template_data

array of objects

Template data could contains array of customized parameters. They may have influence on template display or add values to template.

template_data

object

parameter_name

string

required

Name of the parameter.

value

string

required

Value of the parameter.

last_change

string

Date and time of the last change. (YYYY-MM-DD HH:MM:SS)

total_items

integer

The number of all found message templates.

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Language

Credentials

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://sandbox.crmcarecloud.com/webservice/rest-api/enterprise-interface/v1.0/message-templates?count=100&offset=0' \
3
     --header 'Accept-Language: cs, en-gb;q=0.8' \
4
     --header 'accept: application/json'


xxxxxxxxxx
23
 
1
{
2
  "data": {
3
    "message_templates": [
4
      {
5
        "message_template_id": "8bed991c68a470e7aaeffbf048",
6
        "consent_free_template": true,
7
        "subject": "CRM & CDP CareCloud password setup",
8
        "sender": "\"CRM & CDP CareCloud\"<info@crmcarecloud.com>",
9
        "name": "First CareCloud login",
10
        "message_template_group_id": 2,
11
        "communication_channel_id": 1,
12
        "template_data": [
13
          {
14
            "parameter_name": null,
15
            "value": null
16
          }
17
        ],
18
        "last_change": "2021-11-25 16:57:09"
19
      }
20
    ],
21
    "total_items": 1
22
  }
23
}

200OK

400Bad input parameter. Error message specifies the detail.

401The client has invalid credentials or auth token.

403The client does not exist or the client tried to access non authorized property/resource.

404The resource was not found.

405The resource does not support the specified HTTP method.

500Server is not working as expected.