Tip
Available from CRM.COM R4.0.0

Table of Contents

maxLevel	2

GET segmentation/show
GET segmentation/list
GET segmentation/preview
POST segmentation/exceptional_items/update

GET communications/show

This method returns information related with a communication. Single communication is returned by each call

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

(mandatory)

...

Identifier

The identifier of the communication that should be returned as a result. The allowed communication identifier fields are the following:

...

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

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

...

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

GET communications/list

This method returns information related with a communication. Multiple communications are returned by each call

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

contact_information_identifier (semi-optional)

...

The identifier of the contact information related with the communication that will be returned as results. The allowed contact information identifier fields are the following:

...

(semi-optional)

...

Communication category Identifier

The identifier of the communication category. The allowed communication category identifier fields are the following:

...

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

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

...

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

GET communications/queue/show

...

Tip
Available from CRM.COM R4.0.0

Table of Contents

maxLevel	2

GET segmentation/show
GET segmentation/list
GET segmentation/preview
POST segmentation/exceptional_items/update

GET communications/show

This method returns information related with a communication. Single communication is returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

token

String

The token retrieved from the login method

communication_identifier

(mandatory)

Identifier

The identifier of the communication that should be returned as a result. The allowed communication identifier fields are the following:

Include Page

	V4:communication_identifier
	V4:communication_identifier

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

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Include Page

	V4:communication_queue_complete
	V4:communication_queue_complete

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

GET communications/queue/list

This method returns information related with a communication. Multiple communications are returned by each call

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

GET communications/list

This method returns information related with a communication. Multiple communications are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

contact_information_identifier (semi-optional)

Contact Information identifier

The identifier of the contact information related with the communication that will be returned as results. The allowed contact information identifier fields are the following:

Include Page

	V4:contact_information_identifier
	V4:contact_information_identifier

communication_category_identifier

(semi-optional)

Communication queue category Identifier

The identifier of the communication queuecategory. The allowed communication queue category identifier fields are the following:

Include Page

	V4:communication_queuecategory_identifier
	V4:communication_queuecategory_identifier

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

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Include Page

	V4:communication_queue_complete
	V4:communication_queue_complete

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

GET communications/queue/

...

show

This method returns information related with the queue which is used in order to keep the communications which were saved as completed. Single communication queue is returned by each call

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

(semi-optional)

...

Communication queue Identifier

The identifier of the communication queue. The allowed communication queue identifier fields are the following:

...

number

(mandatory)

...

saved as completed. Single communication queue is returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

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

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Include Page

	V4:communication_queue_complete
	V4:communication_queue_complete

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

...

This method updates a communication. Single communication can be updated by each call. Fields which are not specified are not updated at all. Fields which are specified as null will be set as null.

Resource URL

Parameters

Name	Type	Description
token	String	The token retrieved from the login method
direction (mandatory)	String	The communication direction which can be INCOMING or OUTGOING
media (mandatory)	String	The media that was used to send or receive the communication, which can be EMAIL, SMS, PHONE, LETTER, F2F
category (optional)	String	The category of the communication
subject (mandatory)	String	The subject of the communication
content (mandatory)	String	The content of the communication
from (mandatory)	String	The sender of the communication which holds different type of information based on the selected media and direction.
to (mandatory)	String	The sender of the communication which holds different type of information based on the selected media and direction.
udf_string_1 (optional)	String	User Defined Field of type String
udf_string_2 (optional)	String	User Defined Field of type String
udf_string_3 (optional)	String	User Defined Field of type String
udf_string_4 (optional)	String	User Defined Field of type String
udf_string_5 (optional)	String	User Defined Field of type String
udf_string_6 (optional)	String	User Defined Field of type String
udf_string_7 (optional)	String	User Defined Field of type String
udf_string_8 (optional)	String	User Defined Field of type String
udf_string_9 (optional)	String	User Defined Field of type String
udf_string_10 (optional)	String	User Defined Field of type String
udf_string_11 (optional)	String	User Defined Field of type String
udf_string_12 (optional)	String	User Defined Field of type String
udf_string_13 (optional)	String	User Defined Field of type String
udf_string_14 (optional)	String	User Defined Field of type String
udf_string_15 (optional)	String	User Defined Field of type String
udf_string_16 (optional)	String	User Defined Field of type String
udf_float_1 (optional)	Float	User Defined Field of type Float
udf_float_2 (optional)	Float	User Defined Field of type Float
udf_float_3 (optional)	Float	User Defined Field of type Float
udf_float_4 (optional)	Float	User Defined Field of type Float
udf_float_5 (optional)	Float	User Defined Field of type Float
udf_float_6 (optional)	Float	User Defined Field of type Float
udf_float_7 (optional)	Float	User Defined Field of type Float
udf_float_8 (optional)	Float	User Defined Field of type Float
udf_date_1 (optional)	Date	User Defined Field of type Date
udf_date_2 (optional)	Date	User Defined Field of type Date
udf_date_3 (optional)	Date	User Defined Field of type Date
udf_date_4 (optional)	Date	User Defined Field of type Date
udf_date_5 (optional)	Date	User Defined Field of type Date
udf_date_6 (optional)	Date	User Defined Field of type Date
udf_date_7 (optional)	Date	User Defined Field of type Date
udf_date_8 (optional)	Date	User Defined Field of type Date
contact_information (mandatory)	Contact Information object	The contact information related with the specified communication
referring_to (mandatory)	Referring to object	The entities which are related with the communication and can include Subscriptions, Activities, Jobs, Communications, Accounts Receivable, Bill, Notifications
owned_by_group (mandatory)	Group object	The group that is owning the communication
privacy_level (mandatory)	Privacy level object	The communication's privacy level
log_information (mandatory)	Log Information Object	The log information related with the communication
follow_up_set (mandatory)	Set of follow up communications objects	A list of communications that were created as a follow up of the communication

...

Include Page

	V4:communication_follow_up_short
	V4:communication_follow_up_short

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Include Page

	V4:communication_short
	V4:communication_short

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

Page Comparison

Versions Compared

Old Version 1

New Version 2

Key

GET communications/show

Resource URL

Parameters

Restrictions

Response Data

Examples

GET communications/list

Resource URL

Parameters

Restrictions

Response Data

Examples

GET communications/queue/show

GET communications/show

Resource URL

Parameters

Restrictions

Response Data

Examples

GET communications/queue/list

Resource URL

Parameters

GET communications/list

Resource URL

Parameters

Restrictions

Response Data

Examples

GET communications/queue/

show

Resource URL

Parameters

Resource URL

Parameters

Restrictions

Response Data

Examples

Resource URL

Parameters

Restrictions

Response Data

Examples