Tip
Available from CRM.COM R5.0.0

Table of Contents

maxLevel	2

...

Name

Type

Description

token

String

The token retrieved from the login method

access_token_identifier

(mandatory)

Access Token identifier

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

Include Page

	V4:access_token_identifier
	V4:access_token_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

...

POST access_tokens/create

This method creates a rewards participantan access token. Single rewards participants access tokens can be created by each call.

...

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

Include Page
Name	Type	Description
token	String	The token retrieved from the login method
signauthentication_up_oncode (mandatoryoptional)	Date String	The date that the rewards participant signed up sign_up_by_unit_authentication code of the access token that will be created. If not specified then it will be generated automatically.
identifier (mandatory on conditions)	Unit identifier
V4:unit_identifier	V4:unit_identifier
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 reward 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
participating_schemes_set (optional)	Set of Rewards Participant Scheme Objects	A list of reward schemes that the rewards participant has joint

...

String

The identifier of the access token that will be created. This information is not mandatory if the system is set up to allow creating access tokens with no identifier and pass code.

pass_code

(mandatory on conditions)

String

The pass code of the access token that will be created. This information is not mandatory if the system is set up to allow creating access tokens with no identifier and pass code, although it is always mandatory if an identifier was specified.

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:rewardsaccess_participanttoken_complete
	V4:rewardsaccess_participanttoken_complete

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

...

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

A list of reward schemes that the rewards participant has joint

Name

Type

Description

token

String

The token retrieved from the login method

rewardsaccess_participanttoken_identifier

(mandatory)

Rewards Participant Access Token identifier

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

Include Page

	V4:rewardsaccess_participantstoken_identifier
	V4:rewardsaccess_participantstoken_identifier

sign_up_on

(optional)

Date

The date that the rewards participant signed up

sign_up_by_unit_identifier

(optional)

Unit identifier

Include Page

V4:unit_identifier

udf_string_1

(optional)

String