Edit Achievement Definition
curl --request PUT \
--url https://api.{tenant}.getomneo.com/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,
"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>"
],
"levels": [
{
"name": "<string>",
"display_number": 123,
"trigger": 123,
"description": "<string>",
"repeats": true,
"repeat_interval": 123,
"meta": [
"<string>"
]
}
]
}
'import requests
url = "https://api.{tenant}.getomneo.com/api/v3/achievements/definitions/{definition}"
payload = {
"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,
"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>"],
"levels": [
{
"name": "<string>",
"display_number": 123,
"trigger": 123,
"description": "<string>",
"repeats": True,
"repeat_interval": 123,
"meta": ["<string>"]
}
]
}
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
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,
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>'],
levels: [
{
name: '<string>',
display_number: 123,
trigger: 123,
description: '<string>',
repeats: true,
repeat_interval: 123,
meta: ['<string>']
}
]
})
};
fetch('https://api.{tenant}.getomneo.com/api/v3/achievements/definitions/{definition}', 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/{definition}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'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,
'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>'
],
'levels' => [
[
'name' => '<string>',
'display_number' => 123,
'trigger' => 123,
'description' => '<string>',
'repeats' => true,
'repeat_interval' => 123,
'meta' => [
'<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/{definition}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"region_id\": 123,\n \"currency\": \"<string>\",\n \"description\": \"<string>\",\n \"internal_notes\": \"<string>\",\n \"type\": \"<string>\",\n \"starts_at\": \"2023-12-25\",\n \"ends_at\": \"2023-12-25\",\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 \"levels\": [\n {\n \"name\": \"<string>\",\n \"display_number\": 123,\n \"trigger\": 123,\n \"description\": \"<string>\",\n \"repeats\": true,\n \"repeat_interval\": 123,\n \"meta\": [\n \"<string>\"\n ]\n }\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.{tenant}.getomneo.com/api/v3/achievements/definitions/{definition}")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"region_id\": 123,\n \"currency\": \"<string>\",\n \"description\": \"<string>\",\n \"internal_notes\": \"<string>\",\n \"type\": \"<string>\",\n \"starts_at\": \"2023-12-25\",\n \"ends_at\": \"2023-12-25\",\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 \"levels\": [\n {\n \"name\": \"<string>\",\n \"display_number\": 123,\n \"trigger\": 123,\n \"description\": \"<string>\",\n \"repeats\": true,\n \"repeat_interval\": 123,\n \"meta\": [\n \"<string>\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.{tenant}.getomneo.com/api/v3/achievements/definitions/{definition}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"region_id\": 123,\n \"currency\": \"<string>\",\n \"description\": \"<string>\",\n \"internal_notes\": \"<string>\",\n \"type\": \"<string>\",\n \"starts_at\": \"2023-12-25\",\n \"ends_at\": \"2023-12-25\",\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 \"levels\": [\n {\n \"name\": \"<string>\",\n \"display_number\": 123,\n \"trigger\": 123,\n \"description\": \"<string>\",\n \"repeats\": true,\n \"repeat_interval\": 123,\n \"meta\": [\n \"<string>\"\n ]\n }\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>"
}{
"message": "<string>",
"errors": {}
}Achievement Definition
Edit Achievement Definition
A PUT to the /achievements/definitions/{definitionId} endpoint allows your application edit an Achievement Definition.
PUT
/
v3
/
achievements
/
definitions
/
{definition}
Edit Achievement Definition
curl --request PUT \
--url https://api.{tenant}.getomneo.com/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,
"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>"
],
"levels": [
{
"name": "<string>",
"display_number": 123,
"trigger": 123,
"description": "<string>",
"repeats": true,
"repeat_interval": 123,
"meta": [
"<string>"
]
}
]
}
'import requests
url = "https://api.{tenant}.getomneo.com/api/v3/achievements/definitions/{definition}"
payload = {
"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,
"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>"],
"levels": [
{
"name": "<string>",
"display_number": 123,
"trigger": 123,
"description": "<string>",
"repeats": True,
"repeat_interval": 123,
"meta": ["<string>"]
}
]
}
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
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,
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>'],
levels: [
{
name: '<string>',
display_number: 123,
trigger: 123,
description: '<string>',
repeats: true,
repeat_interval: 123,
meta: ['<string>']
}
]
})
};
fetch('https://api.{tenant}.getomneo.com/api/v3/achievements/definitions/{definition}', 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/{definition}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'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,
'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>'
],
'levels' => [
[
'name' => '<string>',
'display_number' => 123,
'trigger' => 123,
'description' => '<string>',
'repeats' => true,
'repeat_interval' => 123,
'meta' => [
'<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/{definition}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"region_id\": 123,\n \"currency\": \"<string>\",\n \"description\": \"<string>\",\n \"internal_notes\": \"<string>\",\n \"type\": \"<string>\",\n \"starts_at\": \"2023-12-25\",\n \"ends_at\": \"2023-12-25\",\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 \"levels\": [\n {\n \"name\": \"<string>\",\n \"display_number\": 123,\n \"trigger\": 123,\n \"description\": \"<string>\",\n \"repeats\": true,\n \"repeat_interval\": 123,\n \"meta\": [\n \"<string>\"\n ]\n }\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.{tenant}.getomneo.com/api/v3/achievements/definitions/{definition}")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"region_id\": 123,\n \"currency\": \"<string>\",\n \"description\": \"<string>\",\n \"internal_notes\": \"<string>\",\n \"type\": \"<string>\",\n \"starts_at\": \"2023-12-25\",\n \"ends_at\": \"2023-12-25\",\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 \"levels\": [\n {\n \"name\": \"<string>\",\n \"display_number\": 123,\n \"trigger\": 123,\n \"description\": \"<string>\",\n \"repeats\": true,\n \"repeat_interval\": 123,\n \"meta\": [\n \"<string>\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.{tenant}.getomneo.com/api/v3/achievements/definitions/{definition}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"region_id\": 123,\n \"currency\": \"<string>\",\n \"description\": \"<string>\",\n \"internal_notes\": \"<string>\",\n \"type\": \"<string>\",\n \"starts_at\": \"2023-12-25\",\n \"ends_at\": \"2023-12-25\",\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 \"levels\": [\n {\n \"name\": \"<string>\",\n \"display_number\": 123,\n \"trigger\": 123,\n \"description\": \"<string>\",\n \"repeats\": true,\n \"repeat_interval\": 123,\n \"meta\": [\n \"<string>\"\n ]\n }\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>"
}{
"message": "<string>",
"errors": {}
}Path Parameters
The definition ID
Body
application/json
Pattern:
^[A-Z]+$Available options:
visible, hidden, mystery, internal Available options:
monthly, weekly, fortnightly, daily, yearly Show child attributes
Show child attributes
Response
AchievementDefinition
Show child attributes
Show child attributes
⌘I