Skip to main content
POST
Add Achievement Definition

Body

application/json
name
string
required
handle
string
required
levels
object[]
required
Minimum array length: 1
region_id
integer | null
currency
string | null
Pattern: ^[A-Z]+$
description
string | null
internal_notes
string | null
type
string
starts_at
string<date-time> | null
ends_at
string<date-time> | null
is_published
boolean
display_level
boolean | null
display_option
enum<string> | null
Available options:
visible,
hidden,
mystery,
internal
short_description
string | null
long_description
string | null
terms_conditions
string | null
earn_instructions
string | null
icon
string<uri> | null
image_url
string<uri> | null
meta
string[] | null
enable_annual_earn_cycle
boolean
timezone
string | null
period
enum<string> | null
Available options:
monthly,
weekly,
fortnightly,
daily,
yearly
tags
string[]

Response

AchievementDefinition

data
AchievementDefinition · object
required