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/list
GET segmentation/preview
POST segmentation/exceptional_items/update

GET segmentation/show

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

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

Description

token

String

The token retrieved from the login method

segmentation_identifier

(mandatory)

Identifier

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

Include Page

	V4:segmentation_identifier
	V4:segmentation_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

...

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

POST communications/update

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)

...

media

(mandatory)

...

Response Data

Include Page

	V4:segmentation_complete
	V4:segmentation_complete

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

GET segmentation/list

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

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

segmentation_identifier

(mandatory)

Identifier

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

Include Page

	V4:segmentation_identifier
	V4:segmentation_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:segmentation_complete
	V4:segmentation_complete

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

GET segmentation/preview

This method returns information which is included in the segment. Single segmentation is returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

segmentation_identifier

(mandatory)

Identifier

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

Include Page

	V4:segmentation_identifier
	V4:segmentation_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:segmentation_preview_complete
	V4:segmentation_preview_complete

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

POST segmentation/exceptional_items/update

This method updates the exceptional items set. Single set of exceptional items 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

...

111213141516float2Float Floatfloat3Float Floatfloat4Float Floatdate1Date Datedate5Date Date

Name	Type	Description
token	String	The token retrieved from the login method





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_floatstring_18 (optional)Float	String	User Defined Field of type FloatString
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_floatstring_512 (optional)Float	String	User Defined Field of type FloatString
udf_floatstring_613 (optional)Float	String	User Defined Field of type FloatString
udf_floatstring_714 (optional)Float	String	User Defined Field of type FloatString
udf_floatstring_815 (optional)Float	String	User Defined Field of type FloatString
udf_	string_	16 (optional)	String	User Defined Field of type	String
udf_datefloat_21 (optional)	DateFloat	User Defined Field of type DateFloat
udf_datefloat_32 (optional)	DateFloat	User Defined Field of type DateFloat
udf_datefloat_43 (optional)	DateFloat	User Defined Field of type DateFloat
udf_	float_	4 (optional)	Float	User Defined Field of type	Float
udf_datefloat_65 (optional)	DateFloat	User Defined Field of type DateFloat
udf_datefloat_76 (optional)	DateFloat	User Defined Field of type DateFloat
udf_datefloat_87 (optional)	DateFloat	User Defined Field of type DateFloat
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

...

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



log_information (mandatory)	Log Information Object	The log information related with the communication

Anchor

	communication referred objects
	communication referred objects

Referred Objects Response Data

Include Page

	V4:log_information_short
	V4:log_information_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:communicationsegmentation_short
	V4:communicationsegmentation_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 2

New Version 3

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 segmentation/show

Resource URL

Parameters

Restrictions

Response Data

Examples

POST communications/update

Resource URL

Parameters

Response Data

Examples

GET segmentation/list

Resource URL

Parameters

Restrictions

Response Data

Examples

GET segmentation/preview

Resource URL

Parameters

Restrictions

Response Data

Examples

POST segmentation/exceptional_items/update

Resource URL

Parameters

Restrictions

Response Data

Examples