Parameter | Type | Description | Request | Response | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | PUT | POST | DELETE | GET | PUT | POST | DELETE | |||||
name | String | Name of the achievement. Can be translated. | Yes | Yes | Yes | Yes | Yes | |||||
accountId | String | Unique identifier of your account | Yes | Yes | Yes | |||||||
description | String | Description of the achievement. Can be translated. | Optional | Optional | Yes | Yes | Yes | |||||
initialState | Integer | Informs the state of the achievement Acceptable values:
| Yes | Yes | Yes | Yes | Yes | |||||
icon | String | Icon to display for Achievement | Yes | Yes | Yes | Yes | Yes | |||||
ruleSets | Array [Object] | A list of Rule sets to be applied for achievements | Yes | Yes | Yes | Yes | Yes | |||||
deprecated | Boolean | To archive the achievement or not | Yes | Yes | Yes | Yes | Yes | |||||
dependantOn | Array [Object] | An Achievement link model that defines dependency to another achievement | Yes | Yes | Yes | Yes | Yes | |||||
minimumShouldMatch | Integer | The minimum value of the participants that will participate in the achievement | Yes | Yes | Yes | Yes | Yes | |||||
scheduling | Object | A module of Scheduling the occurrence of the achievement | Yes | Yes | Yes | Yes | Yes | |||||
achievementLiveStatus | Enum
| A status of the Achievement | Yes | Yes | Yes | Yes | Yes | |||||
category | Array [String] | Categorisation of the achievements. A list of String | Optional | Optional | Yes | Yes | Yes | |||||
memberGroups | Array [String] | A group of members that can receive the achievement. A list of String | Optional | Optional | Yes | Yes | Yes | |||||
metadata | Array [Object] | A list of Metadata | Optional | Optional | Yes | Yes | Yes | |||||
created | DateTime | ISO8601 timestamp for when an Achievement was created. All records are stored in UTC time zone | Yes | Yes | Yes | |||||||
id | String | Unique system identifier of an Achievement | Yes | Yes | Yes | |||||||
translations | Object | It is a key-value pair of language code and a list of translations. The translatable fields are "name" and "description". Translation model | Optional | Optional | Yes | Yes | Yes | |||||