Skip to main content
POST
/
v3
/
achievements
/
definitions
Add Achievement Definition
curl --request POST \
  --url https://api.{tenant}.getomneo.com/api/v3/achievements/definitions \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "handle": "<string>",
  "levels": [
    {
      "name": "<string>",
      "display_number": 123,
      "trigger": 123,
      "description": "<string>",
      "repeats": true,
      "repeat_interval": 123,
      "allow_multiple_earn": true,
      "meta": [
        "<string>"
      ]
    }
  ],
  "region_id": 123,
  "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,
  "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>",
  "tags": [
    "<string>"
  ]
}
'
import requests

url = "https://api.{tenant}.getomneo.com/api/v3/achievements/definitions"

payload = {
    "name": "<string>",
    "handle": "<string>",
    "levels": [
        {
            "name": "<string>",
            "display_number": 123,
            "trigger": 123,
            "description": "<string>",
            "repeats": True,
            "repeat_interval": 123,
            "allow_multiple_earn": True,
            "meta": ["<string>"]
        }
    ],
    "region_id": 123,
    "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,
    "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>",
    "tags": ["<string>"]
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    handle: '<string>',
    levels: [
      {
        name: '<string>',
        display_number: 123,
        trigger: 123,
        description: '<string>',
        repeats: true,
        repeat_interval: 123,
        allow_multiple_earn: true,
        meta: ['<string>']
      }
    ],
    region_id: 123,
    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,
    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>',
    tags: ['<string>']
  })
};

fetch('https://api.{tenant}.getomneo.com/api/v3/achievements/definitions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.{tenant}.getomneo.com/api/v3/achievements/definitions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'handle' => '<string>',
    'levels' => [
        [
                'name' => '<string>',
                'display_number' => 123,
                'trigger' => 123,
                'description' => '<string>',
                'repeats' => true,
                'repeat_interval' => 123,
                'allow_multiple_earn' => true,
                'meta' => [
                                '<string>'
                ]
        ]
    ],
    'region_id' => 123,
    '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,
    '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>',
    'tags' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.{tenant}.getomneo.com/api/v3/achievements/definitions"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"handle\": \"<string>\",\n  \"levels\": [\n    {\n      \"name\": \"<string>\",\n      \"display_number\": 123,\n      \"trigger\": 123,\n      \"description\": \"<string>\",\n      \"repeats\": true,\n      \"repeat_interval\": 123,\n      \"allow_multiple_earn\": true,\n      \"meta\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"region_id\": 123,\n  \"currency\": \"<string>\",\n  \"description\": \"<string>\",\n  \"internal_notes\": \"<string>\",\n  \"type\": \"<string>\",\n  \"starts_at\": \"2023-11-07T05:31:56Z\",\n  \"ends_at\": \"2023-11-07T05:31:56Z\",\n  \"is_published\": true,\n  \"display_level\": true,\n  \"short_description\": \"<string>\",\n  \"long_description\": \"<string>\",\n  \"terms_conditions\": \"<string>\",\n  \"earn_instructions\": \"<string>\",\n  \"icon\": \"<string>\",\n  \"image_url\": \"<string>\",\n  \"meta\": [\n    \"<string>\"\n  ],\n  \"enable_annual_earn_cycle\": true,\n  \"timezone\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.{tenant}.getomneo.com/api/v3/achievements/definitions")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"handle\": \"<string>\",\n  \"levels\": [\n    {\n      \"name\": \"<string>\",\n      \"display_number\": 123,\n      \"trigger\": 123,\n      \"description\": \"<string>\",\n      \"repeats\": true,\n      \"repeat_interval\": 123,\n      \"allow_multiple_earn\": true,\n      \"meta\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"region_id\": 123,\n  \"currency\": \"<string>\",\n  \"description\": \"<string>\",\n  \"internal_notes\": \"<string>\",\n  \"type\": \"<string>\",\n  \"starts_at\": \"2023-11-07T05:31:56Z\",\n  \"ends_at\": \"2023-11-07T05:31:56Z\",\n  \"is_published\": true,\n  \"display_level\": true,\n  \"short_description\": \"<string>\",\n  \"long_description\": \"<string>\",\n  \"terms_conditions\": \"<string>\",\n  \"earn_instructions\": \"<string>\",\n  \"icon\": \"<string>\",\n  \"image_url\": \"<string>\",\n  \"meta\": [\n    \"<string>\"\n  ],\n  \"enable_annual_earn_cycle\": true,\n  \"timezone\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.{tenant}.getomneo.com/api/v3/achievements/definitions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"handle\": \"<string>\",\n  \"levels\": [\n    {\n      \"name\": \"<string>\",\n      \"display_number\": 123,\n      \"trigger\": 123,\n      \"description\": \"<string>\",\n      \"repeats\": true,\n      \"repeat_interval\": 123,\n      \"allow_multiple_earn\": true,\n      \"meta\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"region_id\": 123,\n  \"currency\": \"<string>\",\n  \"description\": \"<string>\",\n  \"internal_notes\": \"<string>\",\n  \"type\": \"<string>\",\n  \"starts_at\": \"2023-11-07T05:31:56Z\",\n  \"ends_at\": \"2023-11-07T05:31:56Z\",\n  \"is_published\": true,\n  \"display_level\": true,\n  \"short_description\": \"<string>\",\n  \"long_description\": \"<string>\",\n  \"terms_conditions\": \"<string>\",\n  \"earn_instructions\": \"<string>\",\n  \"icon\": \"<string>\",\n  \"image_url\": \"<string>\",\n  \"meta\": [\n    \"<string>\"\n  ],\n  \"enable_annual_earn_cycle\": true,\n  \"timezone\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "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
  }
}
{
  "message": "<string>"
}
{
  "message": "<string>"
}
{
  "message": "<string>",
  "errors": {}
}

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