Skip to main content
POST
/
v3
/
rewards
/
definitions
Add Reward Definition
curl --request POST \
  --url https://api.{tenant}.getomneo.com/api/v3/rewards/definitions \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "handle": "<string>",
  "value": 123,
  "period": 123,
  "region_id": 123,
  "currency": "<string>",
  "max_value": 123,
  "absolute_expiry": "<string>",
  "description": "<string>",
  "short_description": "<string>",
  "long_description": "<string>",
  "terms_conditions": "<string>",
  "earn_instructions": "<string>",
  "icon": "<string>",
  "image_url": "<string>",
  "notify_issue_offset": 123,
  "notify_expiry_offset": 123,
  "issue_target_id": 123,
  "expiry_target_id": 123,
  "extend_target_id": 123,
  "internal_notes": "<string>",
  "is_assignable": true,
  "is_published": true,
  "is_reassignable": true,
  "is_extendable": true,
  "extend_days": 123,
  "notify_issue_offset_days": 123,
  "notify_issue_offset_hour": 123,
  "notify_remind_offset_days": 123,
  "notify_remind_offset_hour": 123,
  "notify_extend_offset_days": 123,
  "notify_extend_offset_hour": 123,
  "tags": [
    "<string>"
  ]
}
'
{
  "data": {
    "id": 123,
    "name": "<string>",
    "handle": "<string>",
    "region_id": 123,
    "region": {
      "id": 123,
      "name": "<string>",
      "handle": "<string>"
    },
    "currency": "<string>",
    "period": 123,
    "period_type": "<string>",
    "absolute_expiry": "<string>",
    "description": "<string>",
    "short_description": "<string>",
    "long_description": "<string>",
    "terms_conditions": "<string>",
    "earn_instructions": "<string>",
    "icon": "<string>",
    "image_url": "<string>",
    "issue_target_id": 123,
    "expiry_target_id": 123,
    "extend_target_id": 123,
    "notify_issue_offset": 123,
    "notify_expiry_offset": 123,
    "notify_schedule_offset": 123,
    "notify_issue_offset_days": 123,
    "notify_issue_offset_hour": 123,
    "notify_remind_offset_days": 123,
    "notify_remind_offset_hour": 123,
    "notify_extend_offset_days": 123,
    "notify_extend_offset_hour": 123,
    "internal_notes": "<string>",
    "type": "<string>",
    "value": 123,
    "max_value": 123,
    "is_extendable": true,
    "is_assignable": true,
    "is_reassignable": true,
    "is_published": true,
    "extend_days": 123,
    "tags": [
      "<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
​
value
number
required
​
type
enum<string>
required
Available options:
activation,
anniversary,
birthday,
bonus,
campaign,
customer-service,
reactivation,
spend,
staff,
system-adjustment,
tier,
achievement,
status,
points,
referral,
other
​
period
integer
required
​
region_id
integer | null
​
currency
string | null
Pattern: ^[A-Z]+$
​
max_value
number | null
​
period_type
enum<string>
Available options:
days,
weeks,
months,
years,
absolute_date,
absolute_week,
absolute_month
​
absolute_expiry
string | null
​
description
string | null
​
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
​
notify_issue_offset
integer | null
​
notify_expiry_offset
integer | null
​
issue_target_id
integer | null
​
expiry_target_id
integer | null
​
extend_target_id
integer | null
​
internal_notes
string | null
​
is_assignable
boolean | null
​
is_published
boolean | null
​
is_reassignable
boolean | null
​
is_extendable
boolean | null
​
extend_days
integer | null
​
notify_issue_offset_days
integer | null
​
notify_issue_offset_hour
integer | null
​
notify_remind_offset_days
integer | null
​
notify_remind_offset_hour
integer | null
​
notify_extend_offset_days
integer | null
​
notify_extend_offset_hour
integer | null
​
tags
string[]

Response

RewardDefinition

​
data
RewardDefinition · object
required