rewards_participant_update_parameters

rewards_participant_update_parameters object data

Name

Type

Description

sign_up_on

(optional)

Date

The date that the rewards participant signed up

If not specified, defaults to the date of the first reward scheme (oldest from the reward scheme set) that the participant signed-up; given that the accounts receivable does not participated in any scheme previously - otherwise it won't be taken into consideration

sign_up_by_unit_identifier

(optional)

Unit identifier

The unit that signed up the rewards participant

If not specified, defaults to the unit of the first reward scheme (oldest from the reward scheme set) that the participant signed-up; given that the accounts receivable does not participated in any scheme previously - otherwise it won't be taken into consideration

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

enable_automatic_spend

(optional)

Boolean

Defines whether the rewards participant requires automatic spend on purchase events or not

minimum_wallet_balance

(optional)

Float

The minimum wallet balance that should be available in order for an automatic awards spending to be applied.

minimum_spend_amount

(optional)

Float

The minimum amount that can be spend by that specific rewards participant during auto spend

maximum_spend_amount

(optional)

Float

The maximum amount that can be spend by that specific rewards participant during auto spend

participating_schemes_set

(optional)

Set of Rewards Participant Scheme Objects

A list of reward schemes that the rewards participant has joint

If no records are specified in the set then nothing will be updated. To update a record use "action" : "update". To remove a record use "action" : "remove". To add a record use "action" : "add". Different actions can be used within the same set. For example:

"set": [
	   		{
            	"action": "update",
            	...........
        	},
			{
            	"action": "remove",
            	...........
			},
			{
            	"action": "add",
            	...........
			}
		]

authorised_rewards_participating_merchants_set

(optional)

Set of Rewards Participating Merchants

It defines the list of merchants which are authorised to perform automatic awards spending on that specific rewards participant, considering that those merchants are also allowing automatic awards spendings. If not specified then all rewards participating merchants are considered as authorised. This is applicable only if the automatic spending is enabled.

If no records are specified in the set then nothing will be updated. To update a record use "action" : "update". To remove a record use "action" : "remove". To add a record use "action" : "add". Different actions can be used within the same set. For example:

"set": [
	   		{
            	"action": "update",
            	...........
        	},
			{
            	"action": "remove",
            	...........
			},
			{
            	"action": "add",
            	...........
			}
		]

Referred Parameter Objects Data

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)

Date

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

email_address

(semi-optional 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 (that is domain specific) or if an email is defined instead of a 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_on

Date

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

(semi-optional 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 semi-optional and It should be specified if the email address is not specified

authorised rewards participating merchants parameters object data

Name

Type

Description

action

(mandatory)

String

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

ADD, REMOVE

rewards_participating_merchant_identifier

(mandatory)

Rewards Participating Merchant Identifier

The rewards participating merchant that should be authorised or de-authorised to perform automatic awards spending. The allowed rewards participating merchant identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the rewards participating merchant

business_unit_identifier

(semi-optional)

Business Unit Identifier

The identifier of the business unit that represents the rewards participating merchant. The allowed business unit identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the business unit

name

(semi-optional)

String

The code of the business unit

code

(semi-optional)

String

The code of the business unit

Available from CRM.COM R18.0.0

unit_identifier

(semi-optional)

Unit Identifier

The identifier of the unit that represents the rewards participating merchant. 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

Deprecated from CRM.COM R18.0.0