Page Comparison

token

String

The token retrieved from the login method

(mandatory)

Rewards Participant identifier  

The identifier of the rewards participant that should be updated. The allowed rewards participant identifier fields are the following:

sign_up_on

(optional)

sign_up_by_unit_identifier

(optional)

The unit that signed up the rewards participant. The allowed unit identifier fields are the following:

enable_automatic_spend

(optional)

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

minimum_wallet_balance

(optional)

The minimum wallet balance that should be available in order for an automatic awards spending to be applied. If specified then automatic awards spends will be created if the rewards participant has an available wallet amount which is equal or more than the minimum amount. This is applicable only if the automatic spending is enabled.

minimum_spend_amount

(optional)

The minimum amount that can be spend by that specific rewards participant during auto spend. If specified then automatic awards spends will be created if the rewards participant has an available amount that can be spend which is equal or more than the minimum amount. This is applicable only if the automatic spending is enabled.

maximum_spend_amount

(optional)

The maximum amount that can be spend by that specific rewards participant during auto spend. If specified then the amount of the automatic awards spends that will be created will be up to that specified amount, even if the available amount that can be spend is more than the maximum amount. This is applicable only if the automatic spending is enabled.

udf_string_1 

(optional)

User Defined Field of type String

udf_string_2

(optional)

User Defined Field of type String

udf_string_3 

(optional)

User Defined Field of type String

udf_string_4 

(optional)

User Defined Field of type String

udf_string_5

(optional)

User Defined Field of type String

udf_string_6 

(optional)

User Defined Field of type String

udf_string_7

(optional)

User Defined Field of type String

udf_string_8

(optional)

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1 

(optional)

Date

User Defined Field of type Date

udf_date_2 

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

access_token

(optional)

The access token that will be associated with the rewards participant

participating_schemes_set

(optional)

A list of reward schemes that the rewards participant has joint

access_tokens_set

(mandatory on conditions)

The access tokens that will be associated with the rewards participant. This information is mandatory if the active access token definition is set up to require at least one access token for each rewards participant

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

"set": [
	   		{
            	"action": "add_existing",
            	...........
        	},
			{
            	"action": "remove",
            	...........
			},
			{
            	"action": "add_new",
            	...........
			}
		]

authorised_rewards_participating_merchants_set

(optional)

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.

fields_set

(optional)