Versions Compared

Old Version 4

changes.mady.by.user George Rossides (Unlicensed)

Saved on

compared with

New Version 5

changes.mady.by.user Joseph Ioannou (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Expand
titlerewards participant schemes object parameter data

 

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

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"

Tip

Available from CRM.COM R15.2.0 and R16.0.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

Tip

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:

Include Page
unit_identifier
unit_identifier

sign_off_onDateinfo

Available from CRM.COM R9

Tip

Available from CRM.COM R9

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:

Include Page
rewards_participant_scheme_identifier
rewards_participant_scheme_identifier

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:

Include Page
reward_scheme_identifier
reward_scheme_identifier

Tip

For releases prior CRM.COM 15.2.0, this parameter was 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")