Available from CRM.

Tip
Tip
Available from CRM.COM R5.0.0

Table of Contents

maxLevel	2

...

This method returns information related with a rewards participants. A single rewards participant is returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

rewards_participant_identifier

(mandatory)

Rewards Participant identifier

The identifier of the rewards participant that should be returned as a result. The allowed rewards participant identifier fields are the following:

Include Page

	V4:rewards_participants_identifier
	V4:rewards_participants_identifier

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

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(semi-optional)

Accounts Receivable identifier

The identifier of the accounts receivable related with the rewards participant that should be returned as a result. The allowed accounts receivable identifier fields are the following:

Include Page

	V4:accounts_receivable_identifier
	V4:accounts_receivable_identifier

contact_information_identifier

(semi-optional)

Contact Information identifier

The identifier of the contact information related with the rewards participant that should be returned as a result. The allowed contact information identifier fields are the following:

Include Page

	V4:contact_information_identifier
	V4:contact_information_identifier

wallet_identifier

(semi-optional)

Wallet identifier

The identifier of the wallet elated with the rewards participant that should be returned as a result. The allowed wallet identifier fields are the following:

Include Page

	V4:wallet_identifier
	V4:wallet_identifier

Tip
Available from CRM.COM R10.0.0

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

...

This method creates a rewards participant. Single rewards participants can be created by each call.

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:

Include Page

	V4:unit_identifier
	V4:unit_identifier

enable_automatic_spend

(optional)

Boolean

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

Tip
Available from CRM.COM R11.0.0

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

accounts_receivable

(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

access_token

(mandatory)

Access Token object

The access token that will be associated with the rewards participant

Tip
Deprecated starting from CRM.COM R8.0.0 onward

participating_schemes_set

(optional)

Set of Rewards Participant Scheme Objects

A list of reward schemes that the rewards participant has joint

access_tokens_set

(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

Tip
Available from CRM.COM R8.0.0

fields_set

(optional)

List of Strings, comma separated

Tip
Available from CRM.COM R10.0.0

Anchor

	rewards participant create referred objects parameters
	rewards participant create referred objects parameters

Referred Parameters Objects Data

...

This method updates rewards participants. A single rewards participant can be updated by each call. Fields which are not specified are not updated at all. Fields which are specified as null will be set as null.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

rewards_participant_identifier

(mandatory)

Rewards Participant identifier

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

Include Page

	V4:rewards_participants_identifier
	V4:rewards_participants_identifier

sign_up_on

(optional)

Date

The date that the rewards participant signed up

sign_up_by_unit_identifier

(optional)

Unit identifier

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

Include Page

	V4:unit_identifier
	V4:unit_identifier

enable_automatic_spend

(optional)

Boolean

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

Tip
Available from CRM.COM R11.0.0

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

access_token

(optional)

Access Token object

The access token that will be associated with the rewards participant

Tip
Deprecated starting from CRM.COM R8.0.0

participating_schemes_set

(optional)

Set of Rewards Participant Scheme Objects

A list of reward schemes that the rewards participant has joint

Include Page

	V4:Web API - Updating Sets
	V4:Web API - Updating Sets

access_tokens_set

(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

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:

Code Block

theme	Confluence
language	javascript
linenumbers	true

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

Tip
Available from CRM.COM R8.0.0

Anchor

	rewards participant update referred objects parameters
	rewards participant update referred objects parameters

Referred Parameters Objects Data

Tip
Deprecated starting from CRM.COM R8.0.0

Include Page

	V4:access_token_parameters
	V4:access_token_parameters

Tip
Available from CRM.COM R8.0.0

Include Page

	V4:access_token_update_parameters
	V4:access_token_update_parameters

...

Expand

title	Example 2

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
   "token":"{{token}}",
    "rewards_participant_identifier": {"number":"RP0000000051"},
    "access_tokens_set":
    [
            {
                "action" :    "add_existing",
                "access_token_identifier" : { "authentication_code" : "222" }
            },
        {
            "action" :    "remove",
                "access_token_identifier" : { "authentication_code" : "1234879456" }
        }
    ]  
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

   {
  "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-07-05T08:35:42",
      "updated_date": "2016-07-05T08:43:42",
      "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": "2016-02-28T15:49:59",
    "udf_date_1": "2016-01-28T15:49:59",
    "udf_date_4": "2016-04-28T15:49:59",
    "udf_date_3": "2016-03-28T15:49:59",
    "participating_schemes_set": [
      {
        "scheme": {
          "alternative_code": "MS",
          "name": "Marketing Scheme",
          "description": null,
          "id": "6CAAD517743C4C179251282A5B2B58A6",
          "life_cycle_state": "EFFECTIVE"
        },
        "sign_up_on": "2016-03-28T15: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": "56BC61EDEBB749B2B92862CB74E00AFC",
        "sign_off_on": null
      },
      {
        "scheme": {
          "alternative_code": "SSS",
          "name": "Sales Scheme",
          "description": "desc",
          "id": "3592610A4F01454E97AF71C9E47646FB",
          "life_cycle_state": "EFFECTIVE"
        },
        "sign_up_on": "2016-03-28T15: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": "1F4D25D0C22D4F47818751D2ABB56979",
        "sign_off_on": null
      }
    ],
    "number": "RP0000000051",
    "udf_float_3": 30,
    "udf_float_4": 40,
    "sign_up_on": "2016-03-28T15: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": "EUR",
      "integer_part_name": null,
      "id": "2"
    },
    "id": "D97CA2ADBD274CD69AC1A27D41E06BF2",
    "udf_float_1": 10,
    "udf_float_2": 20,
    "udf_string_2": "udf string 2",
    "udf_string_3": "udf string 3",
    "udf_string_4": "udf string 4",
    "udf_string_5": "udf string 5",
    "udf_string_1": "udf string 1",
    "accounts_receivable": {
      "number": "ACR0000000272",
      "name": "Jane Austin",
      "id": "9BBF752EC5A5473C8403A0E59BA9B787",
      "life_cycle_state": "ACTIVE",
      "account_owner": {
        "company_profile": null,
        "company_name": null,
        "name": "Jane Markinson",
        "last_name": "Markinson",
        "id": "F3B3D4F601844A88AF5CEED733DBE478",
        "life_cycle_state": "FINANCIAL",
        "middle_name": null,
        "title": null,
        "type": "PERSON",
        "first_name": "Jane",
        "demographics": {
          "name_day": {
            "month": null,
            "day": null
          },
          "id_number": null,
          "gender": null,
          "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
        }
      }
    },
    "udf_string_6": "udf string 6",
    "udf_string_7": "udf string 7",
    "access_tokens_set": [
      {
        "authentication_code": "222",
        "number": "AT0000000034",
        "identifier": "2222222",
        "id": "F60CA93E227342E88571AD1E30C39867",
        "life_cycle_state": "EFFECTIVE",
        "classification": null
      }
    ],
    "udf_string_8": "udf string 8"
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

POST rewards_participants/

...

terminate

Tip
Available from CRM.COM R10R12.10.0

This method enables terminates a rewards participant's spend requests blockin. 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 CUSTOMERREQUEST, 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)

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

access_tokens_set

(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

Anchor

	terminate participant referred objects parameters
	terminate participant referred objects parameters

Referred Parameters Objects Data

Include Page

	V4:access_token_parameters
	V4:access_token_parameters

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Include Page

	V4:rewards_participant_complete
	V4:rewards_participant_complete

POST rewards_participants/enable_spend_blocking

Tip
Available from CRM.COM R10.1.0

This method enables a rewards participant's spend requests blocking. A single rewards participant can be modified in each call.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

rewards_participant_identifier

(mandatory)

Rewards Participant Identifier

The rewards participant whose spend requests blocking state will be enabled/disabled. The allowed rewards participant identifier fields are the following:

Include Page

	V4:rewards_participants_identifier
	V4:rewards_participants_identifier

fields_set

(optional)

List of Strings, comma separated

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Include Page

	V4:rewards_participant_complete
	V4:rewards_participant_complete

...

POST rewards_participants/disable_spend_blocking

Tip
Available from CRM.COM R10.1.0

This method disables a rewards participant's spend requests blocking. A single rewards participant can be modified in each call.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

rewards_participant_identifier

(mandatory)

Rewards Participant Identifier

The rewards participant whose spend requests blocking state will be enabled/disabled. The allowed rewards participant identifier fields are the following:

Include Page

	V4:rewards_participants_identifier
	V4:rewards_participants_identifier

fields_set

(optional)

List of Strings, comma separated

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Include Page

	V4:rewards_participant_complete
	V4:rewards_participant_complete

...

POST rewards_participants/calculate_total_awarded_amount

Tip
Available from CRM.COM R10.1.0

This method calculates the total awarded amount that was provided to a specific rewards participant and the amount that was awarded by each scheme that the rewards participant participated to. A single rewards participant can be specified in each call.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

rewards_participant_identifier

(mandatory)

Rewards Participant Identifier

The rewards participant for which the awarded amount will be calculated for. The allowed rewards participant identifier fields are the following:

Include Page

	V4:rewards_participants_identifier
	V4:rewards_participants_identifier

reward_scheme_identifier

(optional)

Reward Scheme Identifier

The reward scheme that awarded the calculated amount. If specified then the calculation will include only awards provided by the specified reward scheme. The allowed reward scheme identifier fields are the following:

Include Page

	V4:reward_scheme_identifier
	V4:reward_scheme_identifier

from_date

(optional)

Date

If specified then the calculation will include only awards that were provided on that date or on a date after that date will be

to_date

(optional)

Date

If specified then the calculation will include only awards that were provided on that date or on a date before that date will be

fields_set

(optional)

List of Strings, comma separated

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Include Page

	V4:rewards_participant_awarded_amount_complete
	V4:rewards_participant_awarded_amount_complete

...

Versions Compared

Old Version 44

New Version 45

Key

Resource URL

Parameters

Resource URL

Parameters

Resource URL

Parameters

POST rewards_participants/

terminate

Resource URL

Parameters

Response Data

POST rewards_participants/enable_spend_blocking

Resource URL

Parameters

Response Data

POST rewards_participants/disable_spend_blocking

Resource URL

Parameters

Restrictions

Response Data

POST rewards_participants/calculate_total_awarded_amount

Resource URL

Parameters

Restrictions

Response Data

Page Comparison

Versions Compared

Old Version 44

New Version 45

Key

Resource URL

Parameters

Resource URL

Parameters

Resource URL

Parameters

POST rewards_participants/

terminate

Resource URL

Parameters

Response Data

POST rewards_participants/enable_spend_blocking

Resource URL

Parameters

Response Data

POST rewards_participants/disable_spend_blocking

Resource URL

Parameters

Restrictions

Response Data

POST rewards_participants/calculate_total_awarded_amount

Resource URL

Parameters

Restrictions

Response Data