Add Status
curl --request POST \
--url https://api.{tenant}.getomneo.com/api/v3/statuses \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"handle": "<string>",
"sort_order": 123,
"description": "<string>",
"short_description": "<string>",
"long_description": "<string>",
"terms_conditions": "<string>",
"icon": "<string>",
"image_url": "<string>",
"earn_instructions": "<string>",
"internal_notes": "<string>",
"colour": "<string>",
"text_colour": "<string>",
"code": "<string>",
"group_name": "<string>",
"group_handle": "<string>",
"timezone": "<string>",
"period": 123,
"absolute_expiry": "<string>",
"primary_colour": "<string>",
"secondary_colour": "<string>",
"custom_fields": [
{
"namespace": "<string>",
"handle": "<string>",
"value": "<string>"
}
]
}
'import requests
url = "https://api.{tenant}.getomneo.com/api/v3/statuses"
payload = {
"name": "<string>",
"handle": "<string>",
"sort_order": 123,
"description": "<string>",
"short_description": "<string>",
"long_description": "<string>",
"terms_conditions": "<string>",
"icon": "<string>",
"image_url": "<string>",
"earn_instructions": "<string>",
"internal_notes": "<string>",
"colour": "<string>",
"text_colour": "<string>",
"code": "<string>",
"group_name": "<string>",
"group_handle": "<string>",
"timezone": "<string>",
"period": 123,
"absolute_expiry": "<string>",
"primary_colour": "<string>",
"secondary_colour": "<string>",
"custom_fields": [
{
"namespace": "<string>",
"handle": "<string>",
"value": "<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>',
sort_order: 123,
description: '<string>',
short_description: '<string>',
long_description: '<string>',
terms_conditions: '<string>',
icon: '<string>',
image_url: '<string>',
earn_instructions: '<string>',
internal_notes: '<string>',
colour: '<string>',
text_colour: '<string>',
code: '<string>',
group_name: '<string>',
group_handle: '<string>',
timezone: '<string>',
period: 123,
absolute_expiry: '<string>',
primary_colour: '<string>',
secondary_colour: '<string>',
custom_fields: [{namespace: '<string>', handle: '<string>', value: '<string>'}]
})
};
fetch('https://api.{tenant}.getomneo.com/api/v3/statuses', 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/statuses",
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>',
'sort_order' => 123,
'description' => '<string>',
'short_description' => '<string>',
'long_description' => '<string>',
'terms_conditions' => '<string>',
'icon' => '<string>',
'image_url' => '<string>',
'earn_instructions' => '<string>',
'internal_notes' => '<string>',
'colour' => '<string>',
'text_colour' => '<string>',
'code' => '<string>',
'group_name' => '<string>',
'group_handle' => '<string>',
'timezone' => '<string>',
'period' => 123,
'absolute_expiry' => '<string>',
'primary_colour' => '<string>',
'secondary_colour' => '<string>',
'custom_fields' => [
[
'namespace' => '<string>',
'handle' => '<string>',
'value' => '<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/statuses"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"handle\": \"<string>\",\n \"sort_order\": 123,\n \"description\": \"<string>\",\n \"short_description\": \"<string>\",\n \"long_description\": \"<string>\",\n \"terms_conditions\": \"<string>\",\n \"icon\": \"<string>\",\n \"image_url\": \"<string>\",\n \"earn_instructions\": \"<string>\",\n \"internal_notes\": \"<string>\",\n \"colour\": \"<string>\",\n \"text_colour\": \"<string>\",\n \"code\": \"<string>\",\n \"group_name\": \"<string>\",\n \"group_handle\": \"<string>\",\n \"timezone\": \"<string>\",\n \"period\": 123,\n \"absolute_expiry\": \"<string>\",\n \"primary_colour\": \"<string>\",\n \"secondary_colour\": \"<string>\",\n \"custom_fields\": [\n {\n \"namespace\": \"<string>\",\n \"handle\": \"<string>\",\n \"value\": \"<string>\"\n }\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/statuses")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"handle\": \"<string>\",\n \"sort_order\": 123,\n \"description\": \"<string>\",\n \"short_description\": \"<string>\",\n \"long_description\": \"<string>\",\n \"terms_conditions\": \"<string>\",\n \"icon\": \"<string>\",\n \"image_url\": \"<string>\",\n \"earn_instructions\": \"<string>\",\n \"internal_notes\": \"<string>\",\n \"colour\": \"<string>\",\n \"text_colour\": \"<string>\",\n \"code\": \"<string>\",\n \"group_name\": \"<string>\",\n \"group_handle\": \"<string>\",\n \"timezone\": \"<string>\",\n \"period\": 123,\n \"absolute_expiry\": \"<string>\",\n \"primary_colour\": \"<string>\",\n \"secondary_colour\": \"<string>\",\n \"custom_fields\": [\n {\n \"namespace\": \"<string>\",\n \"handle\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.{tenant}.getomneo.com/api/v3/statuses")
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 \"sort_order\": 123,\n \"description\": \"<string>\",\n \"short_description\": \"<string>\",\n \"long_description\": \"<string>\",\n \"terms_conditions\": \"<string>\",\n \"icon\": \"<string>\",\n \"image_url\": \"<string>\",\n \"earn_instructions\": \"<string>\",\n \"internal_notes\": \"<string>\",\n \"colour\": \"<string>\",\n \"text_colour\": \"<string>\",\n \"code\": \"<string>\",\n \"group_name\": \"<string>\",\n \"group_handle\": \"<string>\",\n \"timezone\": \"<string>\",\n \"period\": 123,\n \"absolute_expiry\": \"<string>\",\n \"primary_colour\": \"<string>\",\n \"secondary_colour\": \"<string>\",\n \"custom_fields\": [\n {\n \"namespace\": \"<string>\",\n \"handle\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"name": "<string>",
"handle": "<string>",
"sort_order": "<string>",
"description": "<string>",
"short_description": "<string>",
"long_description": "<string>",
"terms_conditions": "<string>",
"icon": "<string>",
"image_url": "<string>",
"earn_instructions": "<string>",
"colour": "<string>",
"primary_colour": "<string>",
"secondary_colour": "<string>",
"text_colour": "<string>",
"code": "<string>",
"internal_notes": "<string>",
"group_name": "<string>",
"group_handle": "<string>",
"timezone": "<string>",
"period": "<string>",
"period_type": "<string>",
"absolute_expiry": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}Status
Add Status
A POST to the /statuses endpoint allows your application to create a Status record.
POST
/
v3
/
statuses
Add Status
curl --request POST \
--url https://api.{tenant}.getomneo.com/api/v3/statuses \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"handle": "<string>",
"sort_order": 123,
"description": "<string>",
"short_description": "<string>",
"long_description": "<string>",
"terms_conditions": "<string>",
"icon": "<string>",
"image_url": "<string>",
"earn_instructions": "<string>",
"internal_notes": "<string>",
"colour": "<string>",
"text_colour": "<string>",
"code": "<string>",
"group_name": "<string>",
"group_handle": "<string>",
"timezone": "<string>",
"period": 123,
"absolute_expiry": "<string>",
"primary_colour": "<string>",
"secondary_colour": "<string>",
"custom_fields": [
{
"namespace": "<string>",
"handle": "<string>",
"value": "<string>"
}
]
}
'import requests
url = "https://api.{tenant}.getomneo.com/api/v3/statuses"
payload = {
"name": "<string>",
"handle": "<string>",
"sort_order": 123,
"description": "<string>",
"short_description": "<string>",
"long_description": "<string>",
"terms_conditions": "<string>",
"icon": "<string>",
"image_url": "<string>",
"earn_instructions": "<string>",
"internal_notes": "<string>",
"colour": "<string>",
"text_colour": "<string>",
"code": "<string>",
"group_name": "<string>",
"group_handle": "<string>",
"timezone": "<string>",
"period": 123,
"absolute_expiry": "<string>",
"primary_colour": "<string>",
"secondary_colour": "<string>",
"custom_fields": [
{
"namespace": "<string>",
"handle": "<string>",
"value": "<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>',
sort_order: 123,
description: '<string>',
short_description: '<string>',
long_description: '<string>',
terms_conditions: '<string>',
icon: '<string>',
image_url: '<string>',
earn_instructions: '<string>',
internal_notes: '<string>',
colour: '<string>',
text_colour: '<string>',
code: '<string>',
group_name: '<string>',
group_handle: '<string>',
timezone: '<string>',
period: 123,
absolute_expiry: '<string>',
primary_colour: '<string>',
secondary_colour: '<string>',
custom_fields: [{namespace: '<string>', handle: '<string>', value: '<string>'}]
})
};
fetch('https://api.{tenant}.getomneo.com/api/v3/statuses', 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/statuses",
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>',
'sort_order' => 123,
'description' => '<string>',
'short_description' => '<string>',
'long_description' => '<string>',
'terms_conditions' => '<string>',
'icon' => '<string>',
'image_url' => '<string>',
'earn_instructions' => '<string>',
'internal_notes' => '<string>',
'colour' => '<string>',
'text_colour' => '<string>',
'code' => '<string>',
'group_name' => '<string>',
'group_handle' => '<string>',
'timezone' => '<string>',
'period' => 123,
'absolute_expiry' => '<string>',
'primary_colour' => '<string>',
'secondary_colour' => '<string>',
'custom_fields' => [
[
'namespace' => '<string>',
'handle' => '<string>',
'value' => '<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/statuses"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"handle\": \"<string>\",\n \"sort_order\": 123,\n \"description\": \"<string>\",\n \"short_description\": \"<string>\",\n \"long_description\": \"<string>\",\n \"terms_conditions\": \"<string>\",\n \"icon\": \"<string>\",\n \"image_url\": \"<string>\",\n \"earn_instructions\": \"<string>\",\n \"internal_notes\": \"<string>\",\n \"colour\": \"<string>\",\n \"text_colour\": \"<string>\",\n \"code\": \"<string>\",\n \"group_name\": \"<string>\",\n \"group_handle\": \"<string>\",\n \"timezone\": \"<string>\",\n \"period\": 123,\n \"absolute_expiry\": \"<string>\",\n \"primary_colour\": \"<string>\",\n \"secondary_colour\": \"<string>\",\n \"custom_fields\": [\n {\n \"namespace\": \"<string>\",\n \"handle\": \"<string>\",\n \"value\": \"<string>\"\n }\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/statuses")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"handle\": \"<string>\",\n \"sort_order\": 123,\n \"description\": \"<string>\",\n \"short_description\": \"<string>\",\n \"long_description\": \"<string>\",\n \"terms_conditions\": \"<string>\",\n \"icon\": \"<string>\",\n \"image_url\": \"<string>\",\n \"earn_instructions\": \"<string>\",\n \"internal_notes\": \"<string>\",\n \"colour\": \"<string>\",\n \"text_colour\": \"<string>\",\n \"code\": \"<string>\",\n \"group_name\": \"<string>\",\n \"group_handle\": \"<string>\",\n \"timezone\": \"<string>\",\n \"period\": 123,\n \"absolute_expiry\": \"<string>\",\n \"primary_colour\": \"<string>\",\n \"secondary_colour\": \"<string>\",\n \"custom_fields\": [\n {\n \"namespace\": \"<string>\",\n \"handle\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.{tenant}.getomneo.com/api/v3/statuses")
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 \"sort_order\": 123,\n \"description\": \"<string>\",\n \"short_description\": \"<string>\",\n \"long_description\": \"<string>\",\n \"terms_conditions\": \"<string>\",\n \"icon\": \"<string>\",\n \"image_url\": \"<string>\",\n \"earn_instructions\": \"<string>\",\n \"internal_notes\": \"<string>\",\n \"colour\": \"<string>\",\n \"text_colour\": \"<string>\",\n \"code\": \"<string>\",\n \"group_name\": \"<string>\",\n \"group_handle\": \"<string>\",\n \"timezone\": \"<string>\",\n \"period\": 123,\n \"absolute_expiry\": \"<string>\",\n \"primary_colour\": \"<string>\",\n \"secondary_colour\": \"<string>\",\n \"custom_fields\": [\n {\n \"namespace\": \"<string>\",\n \"handle\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"name": "<string>",
"handle": "<string>",
"sort_order": "<string>",
"description": "<string>",
"short_description": "<string>",
"long_description": "<string>",
"terms_conditions": "<string>",
"icon": "<string>",
"image_url": "<string>",
"earn_instructions": "<string>",
"colour": "<string>",
"primary_colour": "<string>",
"secondary_colour": "<string>",
"text_colour": "<string>",
"code": "<string>",
"internal_notes": "<string>",
"group_name": "<string>",
"group_handle": "<string>",
"timezone": "<string>",
"period": "<string>",
"period_type": "<string>",
"absolute_expiry": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}Body
application/json
Available options:
days, weeks, months, years, absolute_date, absolute_week, absolute_month Pattern:
^#[A-Fa-f0-9]{6}$Pattern:
^#[A-Fa-f0-9]{6}$Show child attributes
Show child attributes
Response
StatusOriginal
Show child attributes
Show child attributes
⌘I