Versions Compared

Old Version 5

changes.mady.by.user Joseph Ioannou

Saved on

compared with

New Version Current

changes.mady.by.user Joseph Ioannou

Saved on

Key

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

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...


Tip

Deprecated from CRM.COM R17.0.0


Excerpt

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)

DateThe 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


minimum_wallet_balance

(optional)

Float

The minimum wallet balance that should be available in order for an automatic awards spending to be applied. If specified then automatic awards spends will be created if the rewards participant has an available wallet amount which is equal or more than the minimum amount. This is applicable only if the automatic spending is enabled.

Tip

Available from CRM.COM R13.0.0


minimum_spend_amount

(optional)

Float

The minimum amount that can be spend by that specific rewards participant during auto spend. If specified then automatic awards spends will be created if the rewards participant has an available amount that can be spend which is equal or more than the minimum amount. This is applicable only if the automatic spending is enabled.

Tip

Available from CRM.COM R13.0.0


maximum_spend_amount

(optional)

Float

The maximum amount that can be spend by that specific rewards participant during auto spend. If specified then the amount of the automatic awards spends that will be created will be up to that specified amount, even if the available amount that can be spend is more than the maximum amount. This is applicable only if the automatic spending is enabled.

Tip

Available from CRM.COM R13.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 objectThe 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 ObjectsA 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


authorised_rewards_participating_merchants_set

(optional)

Set of Rewards Participating Merchants

It defines the list of merchants which are authorised to perform automatic awards spending on that specific rewards participant, considering that those merchants are also allowing automatic awards spendings. If not specified then all rewards participating merchants are considered as authorised. This is applicable only if the automatic spending is enabled.

Tip

Available from CRM.COM R13.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

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

...

Expand
titleExample 1

HTTP Method: POST 


Request:

Body:

Code Block
languagejavascript
themeConfluencelanguagejavascript
linenumberstrue
  {
  "token":"A0931BF523A24C819181DC9487343F45",
   "sign_up_on":"2014-07-05T15:49:59",
   "fields_set":"number,sign_up_by_unit,id,participating_schemes_set,accounts_receivable",
  "sign_up_by_unit_identifier":{"name":"Sales Department 1"},
  "udf_string_1":"udf string 1",
   "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_6":"udf string 6",
   "udf_string_7":"udf string 7",
   "udf_string_8":"udf string 8",
   "udf_float_1":10,
   "udf_float_2":20,
   "udf_float_3":30,
   "udf_float_4":40,
   "udf_float_5":50,
   "udf_float_6":60,
   "udf_float_7":70,
   "udf_float_8":80,
   "udf_date_1":"2014-05-05T15:49:59",
   "udf_date_2":"2014-06-05T15:49:59",
   "udf_date_3":"2014-07-05T15:49:59",
   "udf_date_4":"2014-08-05T15:49:59",
   "accounts_receivable":
   {
     "action":"EXISTING",
        "accounts_receivable_identifier":{"number":"ACR000525"}
  },
 
   "participating_schemes_set":
   [
     {
       "sign_up_on": "2014-05-05T15:49:59" ,
       "sign_up_by_unit_identifier":{"name":"Sales Department 1"},
       "reward_scheme_identifier":{"name":"Marketing Reward Scheme"}
     },
     {
       "sign_up_on": "2014-08-05T15:49:59" ,
       "sign_up_by_unit_identifier":{"name":"Sales Department 2"},
       "reward_scheme_identifier":{"name":"Sales Scheme"}
     }
   ],
    "access_tokens_set" :
    [
        {
            "authentication_code" : "125672734874",
            "identifier" : "12365464899",
            "pass_code" : "awe$qew!"
        }
    ]
 }
 
 


Response:
 Code Block
languagejavascript
themeConfluencelanguagejavascript
linenumberstrue
 {
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "accounts_receivable": {
      "account_owner": {
        "last_name": "Mika",
        "middle_name": null,
        "life_cycle_state": "FINANCIAL",
        "company_profile": null,
        "title": "Ms",
        "first_name": "Dina",
        "type": "PERSON",
        "id": "9ED00E7228634EF986807DF4D86A3F84",
        "name": "Mika Dina",
        "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": "14587522",
          "industry": null,
          "id_issued_by_country": null
        }
      },
      "life_cycle_state": "ACTIVE",
      "number": "ACR000525",
      "id": "C8A54A6BB4B9423AA560D6B955CD1271",
      "name": "Dina Mika"
    },
    "number": "147",
    "sign_up_by_unit": {
      "community_name": "Internal Community",
      "id": "A01DEAA885B5B0F14769F983A2F6A16E",
      "name": "Sales Department 1",
      "group_name": "Sales Manager Group",
      "description": null,
      "alternative_code": "SD1"
    },
    "id": "E64F366E3E66476E96E8494BB9F917EA",
    "participating_schemes_set": [
      {
        "sign_up_on": "2014-05-05T15:49:59",
        "sign_off_on": null,
        "scheme": {
          "life_cycle_state": "EFFECTIVE",
          "id": "E339CFB9284E8BB291E63CC42E574E88",
          "name": "Marketing Reward Scheme",
          "description": "Marketing Reward Scheme for Sales Department, CRM Team 1, Marketing Team",
          "alternative_code": "MRS"
        },
        "sign_up_by_unit": {
          "community_name": "Internal Community",
          "id": "A01DEAA885B5B0F14769F983A2F6A16E",
          "name": "Sales Department 1",
          "group_name": "Sales Manager Group",
          "description": null,
          "alternative_code": "SD1"
        },
        "id": "DA225B0204144370A2EF0687C37A8B70"
      },
      {
        "sign_up_on": "2014-08-05T15:49:59",
        "sign_off_on": null,
        "scheme": {
          "life_cycle_state": "EFFECTIVE",
          "id": "EA5CCE98F857F3A928E3AA6891323088",
          "name": "Sales Scheme",
          "description": "Sales Scheme - TC10",
          "alternative_code": "SS"
        },
        "sign_up_by_unit": {
          "community_name": "Internal Community",
          "id": "CA8896C911589FEDB384001606C2440E",
          "name": "Sales Department 2",
          "group_name": "Sales Manager Group",
          "description": "Sales Department 2 under Sales Manager Group",
          "alternative_code": "SD2"
        },
        "id": "3315CBDCA46D48A9875EE70AD53DA19A"
      }
    ]
  }
}
  
          

...
 Expand
titleExample 2
HTTP Method: POST 

Request:
Body:
 Code Block
languagejavascript
themeConfluencelanguagejavascript
linenumberstrue
  {
  "token":"A0931BF523A24C819181DC9487343F45",
   "sign_up_on":"2014-07-05T15:49:59",
   "fields_set":"number,sign_up_by_unit,id,participating_schemes_set,accounts_receivable,access_tokens_set",
  "sign_up_by_unit_identifier":{"name":"Sales Department 1"},
  "udf_string_1":"udf string 1",
   "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_6":"udf string 6",
   "udf_string_7":"udf string 7",
   "udf_string_8":"udf string 8",
   "udf_float_1":10,
   "udf_float_2":20,
   "udf_float_3":30,
   "udf_float_4":40,
   "udf_float_5":50,
   "udf_float_6":60,
   "udf_float_7":70,
   "udf_float_8":80,
   "udf_date_1":"2014-05-05T15:49:59",
   "udf_date_2":"2014-06-05T15:49:59",
   "udf_date_3":"2014-07-05T15:49:59",
   "udf_date_4":"2014-08-05T15:49:59",
   "accounts_receivable":
   {
     "action":"EXISTING",
        "accounts_receivable_identifier":{"number":"ACR001131"}
  },
 
   "participating_schemes_set":
   [
     {
       "sign_up_on": "2014-05-05T15:49:59" ,
       "sign_up_by_unit_identifier":{"name":"Sales Department 1"},
       "reward_scheme_identifier":{"name":"Marketing Reward Scheme"}
     },
     {
       "sign_up_on": "2014-08-05T15:49:59" ,
       "sign_up_by_unit_identifier":{"name":"Sales Department 2"},
       "reward_scheme_identifier":{"name":"Sales Scheme"}
     }
   ],
    "access_tokens_set" :
    [
        {
            "authentication_code" : "1256727348874",
            "identifier" : "123654647899",
            "pass_code" : "awe$qew!"
        }
    ]
 }
 
 


Response:
 Code Block
languagejavascript
themeConfluencelanguagejavascript
linenumberstrue
{
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "accounts_receivable": {
      "account_owner": {
        "last_name": "kyriakou",
        "middle_name": null,
        "life_cycle_state": "FINANCIAL",
        "company_profile": null,
        "title": null,
        "first_name": "maria",
        "type": "PERSON",
        "id": "6BDA97F3B1EA4276A297B424474E7DD3",
        "name": "kyriakou maria",
        "company_name": null,
        "demographics": {
          "gender": "FEMALE",
          "passport_issued_by_country": null,
          "social_security_number": null,
          "passport_number": null,
          "industry_sector": null,
          "country_of_residence": {
            "three_character_code": "CYP",
            "two_character_code": "CY",
            "id": "181",
            "name": "CYPRUS",
            "alternative_code": null
          },
          "name_day": {
            "month": null,
            "day": null
          },
          "date_of_birth": {
            "month": null,
            "day": null,
            "year": null
          },
          "id_number": "3423423423",
          "industry": null,
          "id_issued_by_country": null
        }
      },
      "life_cycle_state": "ACTIVE",
      "number": "ACR001131",
      "id": "0D3BC55501814EF5B9797865C657119B",
      "name": "ACR001131"
    },
    "access_tokens_set": [
      {
        "authentication_code": "1256727348874",
        "life_cycle_state": "EFFECTIVE",
        "classification": null,
        "number": "ACT0000000340",
        "identifier": "123654647899",
        "id": "233807C6EE234BEF8B909238AD28D684"
      }
    ],
    "number": "148",
    "sign_up_by_unit": {
      "community_name": "Internal Community",
      "id": "A01DEAA885B5B0F14769F983A2F6A16E",
      "name": "Sales Department 1",
      "group_name": "Sales Manager Group",
      "description": null,
      "alternative_code": "SD1"
    },
    "id": "5168BB2790064693BAA2B4C4C9A8866F",
    "participating_schemes_set": [
      {
        "sign_up_on": "2014-08-05T15:49:59",
        "sign_off_on": null,
        "scheme": {
          "life_cycle_state": "EFFECTIVE",
          "id": "EA5CCE98F857F3A928E3AA6891323088",
          "name": "Sales Scheme",
          "description": "Sales Scheme - TC10",
          "alternative_code": "SS"
        },
        "sign_up_by_unit": {
          "community_name": "Internal Community",
          "id": "CA8896C911589FEDB384001606C2440E",
          "name": "Sales Department 2",
          "group_name": "Sales Manager Group",
          "description": "Sales Department 2 under Sales Manager Group",
          "alternative_code": "SD2"
        },
        "id": "E528D181A16B4E6EB1B8BA6AE3FB12D2"
      },
      {
        "sign_up_on": "2014-05-05T15:49:59",
        "sign_off_on": null,
        "scheme": {
          "life_cycle_state": "EFFECTIVE",
          "id": "E339CFB9284E8BB291E63CC42E574E88",
          "name": "Marketing Reward Scheme",
          "description": "Marketing Reward Scheme for Sales Department, CRM Team 1, Marketing Team",
          "alternative_code": "MRS"
        },
        "sign_up_by_unit": {
          "community_name": "Internal Community",
          "id": "A01DEAA885B5B0F14769F983A2F6A16E",
          "name": "Sales Department 1",
          "group_name": "Sales Manager Group",
          "description": null,
          "alternative_code": "SD1"
        },
        "id": "A5BB367B54BB4B08A8864002F1181B88"
      }
    ]
  }
}

...
 Expand
titleExample 3
HTTP Method: POST 

Request:
Body:
 Code Block
languagejavascript
themeConfluencelanguagejavascript
linenumberstrue
 {
  "token":"{{token}}",
  "sign_up_on":"2016-03-28T15:00:00",
  "sign_up_by_unit_identifier":{"name":"Admin Unit"},
  "udf_string_1":"udf string 1",
   "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_6":"udf string 6",
   "udf_string_7":"udf string 7",
   "udf_string_8":"udf string 8",
   "udf_float_1":10,
   "udf_float_2":20,
   "udf_float_3":30,
   "udf_float_4":40,
   "udf_float_5":50,
   "udf_float_6":60,
   "udf_float_7":70,
   "udf_float_8":80,
   "udf_date_1":"2016-01-28T15:49:59",
   "udf_date_2":"2016-02-28T15:49:59",
   "udf_date_3":"2016-03-28T15:49:59",
   "udf_date_4":"2016-04-28T15:49:59",
   "accounts_receivable":
   {
    "action":"NEW",
        "name":"Jane Austin",
        "classification_identifier":{"name":"Residential Customer"},
        "credit_rating_code":"AAA",
        "contact_information":{
            "action":"NEW",
            "type":"PERSON",
            "first_name":"Jane",
            "last_name":"Markinson"
        
        }
  },
  "access_token":{
                   "action": "ADD_NEW2",
                   "authentication_code":"PolinaKTesting2",
                   "identifier":"PolinaKTesting2",
                   "pass_code":"12342"
},
   "participating_schemes_set":
   [
     {
       "sign_up_on": "2016-03-28T15:00:00" ,
       "sign_up_by_unit_identifier":{"name":"Admin Unit"},
       "reward_scheme_identifier":{"name":"Marketing Scheme"}
     },
     {
       "sign_up_on": "2016-03-28T15:00:00" ,
       "sign_up_by_unit_identifier":{"name":"Admin Unit"},
       "reward_scheme_identifier":{"name":"Sales Scheme"}
     }
   ],
    "access_tokens_set" :
    [
        {
            "action": "ADD_NEW",
            "authentication_code":"1234879456",
            "identifier":"testAT@crm.com",
            "pass_code":"1234879456a!"
        }
    ]
 }

 

Response:
 Code Block
languagejavascript
themeConfluencelanguagejavascript
linenumberstrue
{
  "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:35:44",
      "updated_by_user": {
        "person_name": "CRM COM",
        "id": "1",
        "email": "dev@crm.com",
        "username": "MPAdministrator"
      },
      "created_by_user": {
        "person_name": "CRM COM",
        "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": "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
      },
      {
        "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
      }
    ],
    "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": "1234879456",
        "number": "AT0000000121",
        "identifier": "testAT@crm.com",
        "id": "B417DE8C9FC74FC4A9A92795A8D3FC1A",
        "life_cycle_state": "EFFECTIVE",
        "classification": null
      }
    ],
    "udf_string_8": "udf string 8"
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

...