...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
| Tip |
|---|
Deprecated from CRM.COM R17.0.0 |
| Excerpt |
|---|
This method creates a rewards participant. Single rewards participants can be created by each call. |
| Tip |
| Available from CRM.COM R5.0 . 0 |
Resource URL
Parameters
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
sign_up_on (mandatory) | Date | The date that the rewards participant signed up | ||||||
sign_up_by_unit_identifier (mandatory) | Unit identifier | The unit that signed up the rewards participant. The allowed unit identifier fields are the following:
| ||||||
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. 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) | Float | 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) | Float | 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) | String | User Defined Field of type String | ||||||
udf_string_2 (optional) | String | User Defined Field of type String | ||||||
udf_string_3 (optional) | String | User Defined Field of type String | ||||||
udf_string_4 (optional) | String | User Defined Field of type String | ||||||
udf_string_5 (optional) | String | User Defined Field of type String | ||||||
udf_string_6 (optional) | String | User Defined Field of type String | ||||||
udf_string_7 (optional) | String | User Defined Field of type String | ||||||
udf_string_8 (optional) | String | 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 | ||||||
(mandatory) | Accounts receivable object | The accounts receivable owned by the rewards participant that identifies the CRM.COM customer, and handles all financial transactions that might be posted as a result of award or spend reward transactions | ||||||
(mandatory) | Access Token object | The access token that will be associated with the rewards participant
| ||||||
(optional) | Set of Rewards Participant Scheme Objects | A list of reward schemes that the rewards participant has joint | ||||||
(mandatory on conditions) | Set of Access Token Objects | 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 |
| ||||
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.
| ||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned
|
Referred Parameters Objects DataAnchor rewards participant create referred objects parameters rewards participant create referred objects parameters
...
| Expand | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
HTTP Method: POST Request: Body:
Response:
|
...
| Expand | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
HTTP Method: POST Request: Body:
Response:
|
...
| Expand | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||
HTTP Method: POST Request: Body:
Response:
|
...