Skip to main content
PUT
/
v3
/
achievements
/
definitions
/
{definition}
Edit Achievement Definition
curl --request PUT \
  --url http://localhost/api/v3/achievements/definitions/{definition} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "region_id": 123,
  "currency": "<string>",
  "description": "<string>",
  "internal_notes": "<string>",
  "type": "<string>",
  "starts_at": "2023-12-25",
  "ends_at": "2023-12-25",
  "is_published": true,
  "display_level": true,
  "display_option": "visible",
  "short_description": "<string>",
  "long_description": "<string>",
  "terms_conditions": "<string>",
  "earn_instructions": "<string>",
  "icon": "<string>",
  "image_url": "<string>",
  "meta": [
    "<string>"
  ],
  "enable_annual_earn_cycle": true,
  "timezone": "<string>",
  "period": "monthly",
  "tags": [
    "<string>"
  ],
  "levels": [
    {
      "name": "<string>",
      "display_number": 123,
      "trigger": 123,
      "description": "<string>",
      "repeats": true,
      "repeat_interval": 123
    }
  ]
}
'
{
  "data": {
    "id": 123,
    "name": "<string>",
    "handle": "<string>",
    "region_id": 123,
    "region": {
      "id": 123,
      "name": "<string>",
      "handle": "<string>"
    },
    "currency": "<string>",
    "description": "<string>",
    "internal_notes": "<string>",
    "type": "<string>",
    "starts_at": "2023-11-07T05:31:56Z",
    "ends_at": "2023-11-07T05:31:56Z",
    "is_published": true,
    "display_level": true,
    "display_option": "<string>",
    "short_description": "<string>",
    "long_description": "<string>",
    "terms_conditions": "<string>",
    "earn_instructions": "<string>",
    "icon": "<string>",
    "image_url": "<string>",
    "levels": [
      {
        "id": 123,
        "name": "<string>",
        "achievement_definition_id": 123,
        "display_number": 123,
        "description": "<string>",
        "trigger": 123,
        "repeats": true,
        "repeat_interval": 123,
        "allow_multiple_earn": true,
        "computed_display_number": "<string>",
        "computed_trigger": "<string>",
        "meta": [
          "<unknown>"
        ]
      }
    ],
    "tags": [
      "<string>"
    ],
    "meta": [
      "<unknown>"
    ],
    "timezone": "<string>",
    "period": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "enable_annual_earn_cycle": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.omneo.io/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

definition
integer
required

The definition ID

Body

application/json
name
string
region_id
integer | null
currency
string | null
Pattern: ^[A-Z]+$
description
string | null
internal_notes
string | null
type
string
starts_at
string<date> | null
ends_at
string<date> | 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[]
levels
object[]

Response

AchievementDefinition

data
AchievementDefinition · object
required