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

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

...

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

entityexceptional_items_set

(mandatory)

StringSet of Segmentation Exceptional Item ObjectsThe entity of the retrieved segment which can be CONTACT_INFORMATION, SUBSCRIPTIONS, ACCOUNTS_RECEIVABLE, BILLS, ACTIVITIES, JOBS

...

segment exceptional item objects to be updated

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

Anchor
segment_exceptional_item_update referred objects parameters
segment_exceptional_item_update referred objects parameters
Referred Parameter Objects Data

Include Page
V4:segment_exceptional_items_update_parameters
V4:segment_exceptional_items_update_parameters

Restrictions

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

...