Step 1: Achievement settings

Fill out the Achievements Name, State and Description. Some fields are mandatory some are optional. You can check more about the achievements model in our API documentation Achievements.

The Settings section consists the basic information about the achievements name, description and status. 

SETTINGS

EXAMPLES 

Status

Required

Enum

The status of the Achievement. 

  • Draft - they are not shown to the public and they can be edited.
  • Live - achievements are exposed to the public and these achievements can not be edited.
Icon

Required

String

An icon to visually display the Achievement

Name

Required

String

The name of the achievement that the player sees when he or she receives the achievement. 

Description

Optional

String

The achievements description visible to players previewing an achievement. 

Initial State

Required

Enum

Informs the state of the achievement.

  • Revealed 
  • Hidden

It can be hidden as in not shown to the user how to get the achievement or revealed.


APP Example:

Status
Draft
Icon

Name
Welcome back
Description
Daily login
Initial state
Revealed

API Example:

{
    "jsonClass": "Achievement",
    ...
    "achievementLiveStatus": "Draft",
    "icon": "07PbzGUBOmEkXOJnaWOs",

    "name": "Welcome back",
    "description": "Daily login",
    "initialState": 0,
    ...
}

A full example of POST Achievement can be found in the Achievements APP API documentation here


 Click Next and continue to the next step.

 If any required information is missing, the field is shown in red as in the example below.