Skip to main content
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>"
    }
  ]
}
'
{
  "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>"
  }
}

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.

Body

application/json
​
name
string
required
​
handle
string
required
​
sort_order
integer | null
​
description
string | null
​
short_description
string | null
​
long_description
string | null
​
terms_conditions
string | null
​
icon
string | null
​
image_url
string | null
​
earn_instructions
string | null
​
internal_notes
string | null
​
colour
string | null
​
text_colour
string | null
​
code
string | null
​
group_name
string | null
​
group_handle
string | null
​
timezone
string | null
​
period
integer | null
​
period_type
enum<string>
Available options:
days,
weeks,
months,
years,
absolute_date,
absolute_week,
absolute_month
​
absolute_expiry
string | null
​
primary_colour
string | null
Pattern: ^#[A-Fa-f0-9]{6}$
​
secondary_colour
string | null
Pattern: ^#[A-Fa-f0-9]{6}$
​
custom_fields
object[]

Response

StatusOriginal

​
data
StatusOriginal · object
required