Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Tip
Available from CRM.COM R12.0.0
Excerpt

This method terminates a rewards participant. A single rewards participant can be terminated in each call.

Tip
Available from CRM.COM R12.0.0

Resource URL

Parameters

NameTypeDescription
tokenStringThe token retrieved from the login method

termination_reason

(mandatory)

StringThe rewards participant's termination reason. Available values are CUSTOMER_REQUEST, FRAUD and DUPLICATION.

rewards_participant_identifier

(mandatory)

Rewards Participant Identifier

The rewards participant that will be terminated. Only effective rewards participants can be terminated. The allowed rewards participant identifier fields are the following:

Include Page
V4:rewards_participants_identifier
V4:rewards_participants_identifier

replaced_by_rewards_participant_identifier

(mandatory based on conditions)

Rewards Participant Identifier

The rewards participant that will replace the terminated rewards participant. The new rewards participant is mandatory when the termination reason reason is set to DUPLICATION and only effective rewards participants can be specified. The allowed rewards participant identifier fields are the following:

Include Page
V4:rewards_participants_identifier
V4:rewards_participants_identifier

transfer_wallet_amount

(optional and applicable on conditions)

 BooleanIndicates whether the terminated rewards participant's remaining wallet balance will be transferred to the new rewards participant's wallet. This is applicable only when the termination reason reason is set to DUPLICATION

access_tokens_set

(optional and applicable on conditions)

Set of Access tokensThe Access Tokens of the terminated rewards participants which will be moved to the new rewards participant. This is applicable only when the termination reason reason is set to DUPLICATION. The set of Access tokens can be a sub-set of the existing access tokens of the terminated rewards participant.

fields_set

(optional)

List of Strings, comma separated 

...