Skip to end of banner
Go to start of banner

rewards_participant_schemes_update_parameter

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Current »

 rewards participant schemes object parameter data

Name

Type

Description

action

(mandatory)

String

Defines if a new or existing information will be updated.The supported values are the following:

ADD, UPDATE, REMOVE

sign_up_on

(mandatory and applicable only on add and update)

DateThe date that the rewards participant signed up for that specific reward scheme

email_address

(mandatory on conditions and only on add and update)

String

The email address that is associated with the unique reference code and was used while signing up to a reward scheme based on supported domains

This available and mandatory only it is required by the specific reward scheme (that is domain specific) and the reference code generation method is set to "AUTO_GENERATED"

Available from CRM.COM R15.2.0

reference_code

(mandatory on conditions and only on add and update)

String

The unique reference code that was used while signing up to that specific reward scheme. This is available and mandatory only if it is required by the specific reward scheme

Available from CRM.COM R12.7.0

sign_up_by_unit_identifier

(mandatory and applicable only on add and update)

Unit identifier

The unit that signed up the rewards participant to that specific reward scheme. The allowed unit identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the Unit

name

(semi-optional)

String

The name of the Unit

alternative_code

(semi-optional)

String

The alternative code of  the Unit

sign_off_onDate

The date that the rewards participant signed off from that specific reward scheme

Available from CRM.COM R9.0.0

rewards_participant_scheme_identifier

(mandatory and applicable only on update or remove)

Rewards Participant Scheme Identifier

The identifier of the activity service to be updated. The allowed activity service identifier fields are the following:

Name

Type

Description

id

(mandatory)

String

The ID of the reward participant participating scheme

reward_scheme_identifier

(mandatory on conditions and applicable only on add)

Reward Scheme Identifier

The reward scheme that the rewards participant has joint. The allowed reward scheme identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the reward scheme

name

(semi-optional)

String

The name of the reward scheme

alternative_code

(semi-optional)

String

The alternative code of  the reward scheme

For releases prior CRM.COM R15.2.0 this parameter is mandatory

From CRM.COM R15.2.0 and onwards this parameter will be mandatory on conditions. It will not be mandatory when an email address and a reference code is provided (given that a reward scheme supports sign ups based on auto-generated reference codes, reference code generation method is set to "AUTO_GENERATED")


  • No labels