Description:
Update a Reward type by Id.
The Reward type that needs to be updated its Id has to exist in the Request body field.
Any Put body Parameters that are excluded in the Request body field will be considered as empty and updated with an empty field
Resource URL:
https://<apphost>.competitionlabs.com/api/<your-space-name>/account/reward-types/<Id>
Request headers
Key | Value | Required |
---|---|---|
X-API-KEY | Your unique API key | Yes |
Content-Type | application/json | Yes |
Request URL parameters
Parameter | Type | Required | Description |
---|---|---|---|
space | String | Yes | This is the space name which is linked to the account |
Put body parameters
Parameter | Type | Required | Description |
---|---|---|---|
name | String | Yes | The name of a reward type |
key | String | Yes | The reference to the reward type in your system |
description | String | Optional | The description of a unit of measure |
system | Boolean | Optional | Default false. True states that the reward type can be deleted |
unitOfMeasureType | String | Yes | A type of unit of measure, eg. Currency, Mass, Time and etc. |
metadata | Array [Object] | Optional | A list of MetaData |
Id | String | Yes | Unique system identifier of a Reward type |
EXAMPLE
ERROR CODES
Code | HTTP Status | Description | Example |
---|---|---|---|
404 | Inserting the Id in the Request URL parameter | ||
503 | Updating without the Id parameter | ||
1001 | 400 |
| |
1007 | 404 | A record with requested id for reward type was not found | |
1002 | 404 |
|