Versions Compared

Key

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

...

...

...

...

...

...


Tip

Available from CRM.COM R10.1.0

Deprecated from CRM.COM R17.0.0


Excerpt

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

Tip
Available from CRM.COM R10

.

1.0

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_post
V4:rewards_participants_identifier_post

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.

...

Expand
titleExample 1

HTTP Method: POST

 


Request:

Body:

Code Block
languagejavascript
themeConfluencelanguagejavascript
linenumberstrue
 {
  "token":"D2C2B14EE43E42AA80DFF05CB8E3F635",
  "rewards_participant_identifier":{"number":"RP0000000086"}
}
 


Response:

Code Block
 {
  "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-09-13T09:47:15",
      "updated_date": "2016-09-13T09:54:18",
      "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": null,
    "udf_date_1": null,
    "udf_date_4": null,
    "udf_date_3": null,
    "participating_schemes_set": [],
    "number": "RP0000000086",
    "udf_float_3": null,
    "udf_float_4": null,
    "sign_up_on": "2014-09-13T15: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": "GBP",
      "integer_part_name": null,
      "id": "9"
    },
    "id": "51D6C9C39B8445D488F67766F3F2AE3A",
    "udf_float_1": null,
    "udf_float_2": null,
    "udf_string_2": "2",
    "udf_string_3": null,
    "udf_string_4": null,
    "udf_string_5": null,
    "udf_string_1": null,
    "accounts_receivable": {
      "number": "ACR0000000010",
      "name": "ACR0000000010 Joe Rogan",
      "id": "F98FFAE225DB47B3BDC32E8FDA81ACFC",
      "life_cycle_state": "ACTIVE",
      "account_owner": {
        "company_profile": null,
        "company_name": null,
        "name": "Joe Rogan",
        "last_name": "Rogan",
        "id": "20798E691E4541B8A078CCB12239B9D4",
        "life_cycle_state": "FINANCIAL",
        "middle_name": null,
        "title": null,
        "type": "PERSON",
        "first_name": "Joe",
        "demographics": {
          "name_day": {
            "month": null,
            "day": null
          },
          "id_number": null,
          "gender": null,
          "country_of_residence": {
            "alternative_code": "IRN",
            "three_character_code": null,
            "name": "IRAN (ISLAMIC REPUBLIC OF)",
            "id": "231",
            "two_character_code": null
          },
          "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
        }
      }
    },
    "spend_blocking_state": {
      "updated_date": "Tue Sep 13 09:54:18 EEST 2016",
      "updated_by_user": {
        "person_name": "CRM COM",
        "id": "1",
        "email": "dev@crm.com",
        "username": "MPAdministrator"
      },
      "enabled": true
    },
    "udf_string_6": null,
    "udf_string_7": "7",
    "access_tokens_set": [],
    "udf_string_8": null
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}


...