Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Tip

Available from CRM.COM R9.0.0

Excerpt

This method returns the communication templates that are allowed to be used in communications. Multiple communication templates are returned by each call. Note that only effective communication templates are retrieve by this method.

...

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

group_identifier

(optional)

Group Identifier

The identifier of the group that will be creating the communication. The group is filtered against the templates' allowed organisational units. The allowed group identifier fields are the following:

Include Page
V4:group_identifier
V4:group_identifier

unit_identifier

(optional)

Unit Identifier

The identifier of the unit that will be creating the communication. The unit is filtered against the templates' allowed organisational units. The allowed unit identifier fields are the following:

Include Page
V4:unit_identifier
V4:unit_identifier

direction

(optional)

StringThe direction of the communication templates that will be retrieved, which can be INCOMING or OUTGOING

media

(optional)

StringThe media of the communication templates that will be retrieved, which can be EMAIL, SMS, PHONE, LETTER, F2F

category_identifier

(optional)

Category Identifier

The category of the communication template that will be retrieved. The allowed communication category identifiers are the following:

Include Page
V4:communication_category_identifier
V4:communication_category_identifier

communication_queue_external_system_identifierCommunication Queue External System Identifier

The communication queue external system of the communication template that will be retrieved. The allowed communication queue external system identifiers are the following:

Include Page
V4:communication_queue_external_system_identifier
V4:communication_queue_external_system_identifier

Tip

Available from CRM.COM R10.0.0

fields_set

(optional)

List of Strings, comma separated 

A list of fields that should be included in the results. If not specified then all the available fields will be returned

...