Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...


Tip

Deprecated from CRM.COM R18.0.0


Excerpt

This method updates access tokens. A single access token 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

access_token_identifier

(mandatory)

Access Token identifier  

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

Include Page
V4:access_token_identifier
V4:access_token_identifier

authentication_code

(

optional

mandatory on conditions)

String

The authentication code of the access token that will be updated.

Is specified as null then the authentication code will be regenerated automatically

This information is not mandatory if set to be generated automatically, in the definition or the classification.

identifier

(mandatory on conditions)

String

The identifier of the access token that will be update. 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)

StringThe pass code of the access token that will be updated. 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. 
udf

card_

string

masked_

1

number

(optional)

String

User Defined Field of type String

TipAvailable from CRM.COM

The masked number of the credit card that will be related to the access token

  • Applicable only when the authentication code is related with a credit card
Tip

Available from CRM.COM R16.2.0


udf_string_1

(optional)

String

User Defined Field of type String

Tip

Available from CRM.COM R10.1.0


udf_string_2

(optional)

String

User Defined Field of type String

Tip

Available from CRM.COM R10.1.0


udf_string_3

(optional)

String

User Defined Field of type String

Tip

Available from CRM.COM R10.1.0


udf_string_4

(optional)

String

User Defined Field of type String

Tip

Available from CRM.COM R10.1.0


udf_string_5

(optional)

String

User Defined Field of type String

Tip

Available from CRM.COM R10.1.0


udf_string_6

(optional)

String

User Defined Field of type String

Tip

Available from CRM.COM R10.1.0


udf_string_7

(optional)

String

User Defined Field of type String

Tip

Available from CRM.COM R10.1.0


udf_string_8

(optional)

String

User Defined Field of type String

Tip

Available from CRM.COM R10.1.0


udf_float_1

(optional)

Float

User Defined Field of type Float

Tip

Available from CRM.COM R10.1.0


udf_float_2

(optional)

Float

User Defined Field of type Float

Tip

Available from CRM.COM R10.1.0


udf_float_3

(optional)

Float

User Defined Field of type Float

Tip

Available from CRM.COM R10.1.0


udf_float_4

(optional)

Float

User Defined Field of type Float

Tip

Available from CRM.COM R10.1.0


udf_date_1

(optional)

Date

User Defined Field of type Date

Tip

Available from CRM.COM R10.1.0


udf_date_2

(optional)

Date

User Defined Field of type Date

Tip

Available from CRM.COM R10.1.0


udf_date_3

(optional)

Date

User Defined Field of type Date

Tip

Available from CRM.COM R10.1.0


udf_date

_4

(optional)

Date

User Defined Field of type Date

_4

(optional)

Date

User Defined Field of type Date

Tip

Available from CRM.COM R10.1.0


custom_field_set

(optional)

Set of Custom Fields

The custom fields that are associated with the access token

If no records are specified in the set then nothing will be updated. To add or update a value on a custom field use the custom field name as configured in CRM.COM along with the respective value. To remove a value from a custom field use the custom field name as configured in CRM.COM along with an empty value

Code Block
languagejavascript
themeConfluence
linenumberstrue
"custom_field_set": [
	{"field_name" : "value"},
	{"field_name" : "value"}
]


Tip

Available from CRM.COM

R10

R16.

1

2.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

Tip

Available from CRM.COM R10.0.0


Restrictions

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

...

Expand
titleExample 1

HTTP Method: POST 


Request:

Body:

Code Block
languagejavascript
themeConfluencelanguagejavascript
linenumberstrue
{
       "token":"A4F19B70D95D4DE09C3A9FC720A33A49",
       "access_token_identifier" : {"authentication_code":"CCD4537CA4AD4EE8912FFBAE53110601"},
       "authentication_code":"testpassnew1",
       "identifier":"api1test12up",
       "pass_code":"api11112"
}
 


Response:

Code Block
languagejavascript
themeConfluencelanguagejavascript
linenumberstrue
    {
       "status":
       {
           "message": "",
           "description": "",
           "code": "OK"
       },
       "data":
       {
           "log_information":
           {
               "updated_date": "2015-05-27T12:50:22",
               "created_date": "2015-02-16T14:23:46",
               "created_by_unit":
               {
                   "community_name": "Internal Community",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "name": "Admin Unit",
                   "group_name": "Main Group",
                   "description": "r1",
                   "alternative_code": "MG"
               },
               "updated_by_unit":
               {
                   "community_name": "Internal Community",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "name": "Admin Unit",
                   "group_name": "Main Group",
                   "description": "r1",
                   "alternative_code": "MG"
               },
               "created_by_user":
               {
                   "person_name": "p_xenopoulou",
                   "username": "p_xenopoulou",
                   "id": "159C17D9C4B1E48DC129FBC701D38438",
                   "email": "p_xenopoulou@crm.com"
               },
               "updated_by_user":
               {
                   "person_name": "Marios Lannister",
                   "username": "MPAdministrator",
                   "id": "1"
               }
           },
           "reward_participant":
           {
               "accounts_receivable":
               {
                   "account_owner":
                   {
                       "last_name": "Havier",
                       "middle_name": null,
                       "life_cycle_state": "FINANCIAL",
                       "company_profile": null,
                       "title": null,
                       "first_name": "Shemar",
                       "type": "PERSON",
                       "id": "E21381FCC07AB01BAAC3851B6C00FFE5",
                       "name": null,
                       "company_name": null,
                       "demographics":
                       {
                           "gender": null,
                           "passport_issued_by_country": null,
                           "social_security_number": null,
                           "passport_number": null,
                           "industry_sector": null,
                           "name_day":
                           {
                               "month": null,
                               "day": null
                           },
                           "date_of_birth":
                           {
                               "month": null,
                               "day": null,
                               "year": null
                           },
                           "id_number": null,
                           "industry": null,
                           "id_issued_by_country": null
                       }
                   },
                   "life_cycle_state": "ACTIVE",
                   "number": "ACR000418",
                   "id": "8728513FDA0C6919AE007D84938A835B",
                   "name": "Havier 6"
               },
               "number": "28",
               "id": "2432994125F2450EBDF84E00B21C89F0"
           },
           "authentication_code": "testpassnew1",
           "accounts_receivable":
           {
               "account_owner":
               {
                   "last_name": "Havier",
                   "middle_name": null,
                   "life_cycle_state": "FINANCIAL",
                   "company_profile": null,
                   "title": null,
                   "first_name": "Shemar",
                   "type": "PERSON",
                   "id": "E21381FCC07AB01BAAC3851B6C00FFE5",
                   "name": "Havier Shemar",
                   "company_name": null,
                   "demographics":
                   {
                       "gender": null,
                       "passport_issued_by_country": null,
                       "social_security_number": null,
                       "passport_number": null,
                       "industry_sector": null,
                       "country_of_residence":
                       {
                           "three_character_code": "USA",
                           "two_character_code": "US",
                           "id": "127",
                           "name": "UNITED STATES",
                           "alternative_code": null
                       },
                       "name_day":
                       {
                           "month": null,
                           "day": null
                       },
                       "date_of_birth":
                       {
                           "month": null,
                           "day": null,
                           "year": null
                       },
                       "id_number": null,
                       "industry": null,
                       "id_issued_by_country": null
                   }
               },
               "life_cycle_state": "ACTIVE",
               "number": "ACR000418",
               "id": "8728513FDA0C6919AE007D84938A835B",
               "name": "Havier 6"
           },
           "life_cycle_state": "EFFECTIVE",
           "identifier": "api1test12up",
           "number": "35",
           "id": "CDC003FAB1204830ACED364BA77EC18D"
       }
}


...