Skip to main content
POST
/
v3
/
rewards
Add Reward
curl --request POST \
  --url http://localhost/api/v3/rewards \
  --header 'Content-Type: application/json' \
  --data '
{
  "timezone": "<string>",
  "profile_id": "<string>",
  "value_initial": 123,
  "value_remaining": 123,
  "expires_at": "2023-11-07T05:31:56Z",
  "issued_at": "2023-11-07T05:31:56Z",
  "reward_definition_id": 123,
  "reward_definition_handle": "<string>",
  "meta": [
    "<string>"
  ],
  "external_id": "<string>"
}
'
{
  "data": {
    "id": 123,
    "profile_id": "<string>",
    "timezone": "<string>",
    "value_initial": "<string>",
    "value_remaining": "<string>",
    "has_notified_issue": true,
    "has_notified_expiry": true,
    "has_notified_extend": true,
    "expires_at": "<string>",
    "issued_at": "<string>",
    "is_expired": "<string>",
    "is_active": "<string>",
    "issued_local_at": "<string>",
    "expires_local_at": "<string>",
    "notify_issue_at": "<string>",
    "notify_expiry_at": "<string>",
    "extended_at": "<string>",
    "definition": {
      "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>"
    },
    "meta": [
      "<unknown>"
    ],
    "created_at": "<string>",
    "updated_at": "<string>",
    "source_id": 123,
    "source_type": "<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
timezone
string
required
profile_id
string
required
value_initial
number
value_remaining
number
expires_at
string<date-time>
issued_at
string<date-time>
reward_definition_id
integer
reward_definition_handle
string
meta
string[] | null
external_id
string | null

Response

Reward

data
Reward · object
required