Versions Compared

Key

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

Available from CRM.COM R9.0.0

Excerpt

This method returns the effective reward schemes that are allowed to be provided to rewards participants. Multiple reward schemes are returned by each call. Note that only effective reward schemes are retrieved.

...

Name

Type

Description

token

String

The token retrieved from the login method

group_identifier

(optional)

Group Identifier

The identifier of the group that will be providing the reward scheme. The group is filtered against the reward scheme's allowed organisational units. The allowed group identifier fields are the following:

Include Page
V4:group_identifier
V4:group_identifier

Tip

Deprecated from CRM.COM R15.0.0

unit_identifier

(optional)

Unit Identifier

The identifier of the unit that will be providing the reward scheme. The unit is filtered against the reward scheme's allowed organisational units. The allowed unit identifier fields are the following:

Include Page
V4:unit_identifier
V4:unit_identifier

Tip

Deprecated from CRM.COM R15.0.0

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

...