This method terminates a rewards participant. A single rewards participant can be terminated in each call.
Resource URL
Parameters
| Name | Type | Description | |||||||||
| token | String | The token retrieved from the login method | |||||||||
termination_reason (mandatory) | String | The 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:
| |||||||||
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:
| |||||||||
transfer_wallet_amount (optional and applicable on conditions) | Boolean | Indicates 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 | |||||||||
(optional and applicable on conditions) | Set of Access tokens | The 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 |
Referred Parameters Objects Data
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved rewards participant |
number | String | The number of the retrieved rewards participant |
| sign_up_on | Date | The date that the rewards participant signed up |
| life_cycle_state | String | The life cycle state of the rewards participant. Available values are EFFECTIVE and TERMINATED Available from CRM.COM R12.0.0 |
udf_string_1 | String | User DefinedField of type String |
udf_string_2 | String | User DefinedField of type String |
udf_string_3 | String | User DefinedField of type String |
udf_string_4 | String | User DefinedField of type String |
udf_string_5 | String | User DefinedField of type String |
udf_string_6 | String | User DefinedField of type String |
udf_string_7 | String | User DefinedField of type String |
udf_string_8 | String | User DefinedField of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
Log Information object | The log informationrelatedwiththeretrieved job | |
| accounts_receivable | Accounts receivable object | The accounts receivable owned by the rewards participant |
| sign_up_by_unit | Unit object | The unit that signed up the rewards participant |
| access_token | Access Token object | The access token associated with the rewards participant Deprecated starting from CRM.COM R8.0.0 onward |
| currency | Currencyobject | The reward participant's currency Available from CRM.COM R10.0.0 |
| auto_spend_authorisation | Auto Spend Settings Object | The reward's participant's automaticspendsettings Available from CRM.COM R11.0.0 |
| spend_blocking_state | Rewards Participant Spend Requests Blocking State object | The rewards participant's spend requests blocking state Available from CRM.COM R10.1.0 |
| termination_information | Rewards Participant Termination Information object | The Rewards Participant's termination information. Applicable only for Rewards Participants in TERMINATED life cycle state. Available from CRM.COM R12.0.0 |
| wallet | Wallet Object | The wallet related to the rewards participant Available from CRM.COM R12.1.0 |
| participating_schemes_set | Set of Rewards Participant Scheme Objects | A list of reward schemes that the rewards participant has joint. |
| access_tokens_set | Set of Access Token Objects | A list of all the access tokens that are related with the rewards participant Available from CRM.COM R8.0.0 |
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token":"{{token}}",
"rewards_participant_identifier":{"number":"RP0000000128"},
"termination_reason":"DUPLICATION",
"replaced_by_rewards_participant_identifier":{"number":"RP0000000146"},
"transfer_wallet_amount":false,
"access_tokens_set":
[
{
"action":"ADD_EXISTING",
"access_token_identifier":{"authentication_code":"accesstoken123"}
},
{
"action":"new",
"authentication_code":"accesstoken1234",
"pass_code":"accessToken1234"
}
]
}
Response:
{
"data": {
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2016-10-20T09:56:30",
"updated_date": "2016-12-08T13:51:51",
"updated_by_user": {
"person_name": "CRM COM",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"udf_date_2": null,
"udf_date_1": null,
"udf_date_4": null,
"udf_date_3": null,
"participating_schemes_set": [
{
"scheme": {
"alternative_code": "RSB1SM",
"name": "Rewards Story Board 12 Scheme MA",
"description": null,
"id": "CC7FB6E02C0E416E8B8E6B32C443CDCF",
"life_cycle_state": "EFFECTIVE"
},
"sign_up_on": "2016-10-01T00:00:00",
"sign_up_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"id": "99C110FAE1DA43C3A1EBF40714E0B3F0",
"sign_off_on": null
}
],
"number": "RP0000000128",
"udf_float_3": null,
"udf_float_4": null,
"sign_up_on": "2016-10-01T00:00:00",
"sign_up_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"currency": {
"suffix_symbol": null,
"prefix_symbol": "£",
"decimal_part_name": null,
"code": "GBP",
"integer_part_name": null,
"id": "9"
},
"id": "F1E4F5F371F54DF9902522127061F431",
"udf_float_1": null,
"udf_float_2": null,
"udf_string_2": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_1": null,
"accounts_receivable": {
"number": "ACR0000000497",
"name": "ACR0000000497 Melany Anton",
"id": "41042C7A31914AFD82BC9B2F19BA89BF",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": "Melany Anton",
"last_name": "Anton",
"id": "E6B41F80110B4B9293A3552253571A76",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Melany",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": "546712",
"gender": "FEMALE",
"country_of_residence": {
"alternative_code": "CYP",
"three_character_code": "CYP",
"name": "CYPRUS",
"id": "181",
"two_character_code": "CY"
},
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
}
},
"auto_spend_authorisation": {
"updated_date": "2016-10-20T09:58:01",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"enabled": false
},
"life_cycle_state": "TERMINATED",
"spend_blocking_state": {
"updated_date": null,
"updated_by_user": null,
"enabled": false
},
"termination_information": {
"termination_date": "2016-12-08T13:51:23",
"termination_reason": "DUPLICATION",
"terminated_by_user": {
"person_name": "CRM COM",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"udf_string_6": null,
"udf_string_7": null,
"access_tokens_set": [],
"udf_string_8": null
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}