Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Expand
titleaccess_token_parameters object data

Name

Type

Description

action

(mandatory)

String

Defines if a new or existing contact information access token should be used. The supported values are the following:

NEW, EXISTINGcontact_information

The NEW option can be used only if access tokens are allowed to be created on creating reward participants, as specified in access token definitions

access_token_identifier

(mandatory on conditions)

Contact information Access Token identifier

An existing contact information access token that should be used. This is applicable and mandatory if the action is set to EXISTING. Only effective access tokens can be used. The allowed contact information access token identifier fields are the following:

Include Page
contactaccess_informationtoken_identifiercontact
access_informationtoken_identifier
type

authentication_code

(optional)

String

The authentication code of the access token that will be created. If not specified then it will be generated automatically. Applicable and if the action is set to NEW

identifier

(mandatory on conditions)

String

The type identifier of the contact information which can be PERSON or COMPANYaccess 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. Applicable and mandatory if the action is set to NEW

titlepass_code

(optionalmandatory on conditions)

StringThe title pass code of the contact information. Applicable only if the type is PERSON and 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. Applicable and if the action is set to NEW