Get a message template

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

Get information about a specific message template.

Responses

Response body

object

data

object

Message template resource.

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)

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/message_template_id \
3
     --header 'Accept-Language: cs, en-gb;q=0.8' \
4
     --header 'accept: application/json'


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

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.