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

...

Name

Type

Description

token

String

The token retrieved from the login method

entity

(mandatory)

StringThe entity of the segments to be retrieved which can be CONTACTINFORMATION, SUBSCRIPTIONS,ACCOUNTSRECEIVABLE, 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

...

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

...

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

...