Versions Compared

Key

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

Available from CRM.COM R4.0.0

Table of Contents
maxLevel2

...

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

...

  • 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

...

Name

Type

Description

token

String

The token retrieved from the login method

entityStringThe entity of the segments to be retrieved which can be CONTACT_INFORMATION, SUBSCRIPTIONS, ACCOUNTS_RECEIVABLE, BILLS, ACTIVITIES, JOBS

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

...

  • 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

...

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

...

  • 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_short
V4:segmentation_preview_short

...

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

exceptional_items_set

(mandatory)

Set of Segmentation Exceptional Item ObjectsThe segment exceptional item objects to be updated

Include Page
V4:Web API - Updating Sets
V4:Web API - Updating Sets

...

  • 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

...