Skip to main content
POST
/
v3
/
benefits
/
definitions
Add Benefit Definition
curl --request POST \
  --url http://localhost/api/v3/benefits/definitions \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "handle": "<string>",
  "period": 123,
  "region_id": 123,
  "currency": "<string>",
  "period_type": "days",
  "absolute_expiry": "<string>",
  "description": "<string>",
  "internal_notes": "<string>",
  "meta": [
    "<string>"
  ],
  "short_description": "<string>",
  "long_description": "<string>",
  "terms_conditions": "<string>",
  "earn_instructions": "<string>",
  "redeem_instructions_store": "<string>",
  "redeem_instructions_online": "<string>",
  "redeem_code_pos": "<string>",
  "redeem_code_online": "<string>",
  "icon": "<string>",
  "image_url": "<string>",
  "max_redemptions": 123,
  "is_extendable": true,
  "is_assignable": true,
  "is_reassignable": true,
  "end_at": "2023-11-07T05:31:56Z",
  "is_claimable": true,
  "claim_period_start_at": "2023-11-07T05:31:56Z",
  "claim_period_end_at": "2023-11-07T05:31:56Z",
  "max_global_redemptions": 123,
  "claim_condition": [
    "<string>"
  ],
  "is_reclaimable": true,
  "issue_target_id": 123,
  "remind_target_id": 123,
  "extend_target_id": 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,
  "force_allocation": true,
  "is_published": true,
  "is_archived": true,
  "claim_timeframe": [
    "<string>"
  ],
  "view_condition": [
    "<string>"
  ],
  "visibility_condition": [
    "<string>"
  ],
  "allow_user_redeem": true,
  "value": 123,
  "campaign": "<string>",
  "type": "discount",
  "external_id": "<string>",
  "tags": [
    "<string>"
  ]
}
'
{
  "data": {
    "id": "<string>",
    "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>",
    "internal_notes": "<string>",
    "meta": [
      "<unknown>"
    ],
    "short_description": "<string>",
    "long_description": "<string>",
    "terms_conditions": "<string>",
    "earn_instructions": "<string>",
    "redeem_instructions_store": "<string>",
    "redeem_instructions_online": "<string>",
    "redeem_code_pos": "<string>",
    "redeem_code_online": "<string>",
    "icon": "<string>",
    "image_url": "<string>",
    "max_redemptions": 123,
    "is_extendable": true,
    "is_assignable": true,
    "is_reassignable": true,
    "is_published": true,
    "is_archived": true,
    "tags": [
      "<string>"
    ],
    "is_claimable": true,
    "max_global_redemptions": 123,
    "total_global_redemptions_remaining": 123,
    "total_global_redemptions": 123,
    "total_global_created": 123,
    "claim_period_start_at": "<string>",
    "claim_period_end_at": "<string>",
    "claim_condition": [
      "<unknown>"
    ],
    "is_reclaimable": true,
    "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,
    "remind_target_id": 123,
    "extend_target_id": 123,
    "issue_target_id": 123,
    "end_at": "<string>",
    "total_allocations": null,
    "total_allocations_remaining": null,
    "force_allocation": true,
    "created_at": "<string>",
    "updated_at": "<string>",
    "claim_timeframe": [
      "<unknown>"
    ],
    "view_condition": [
      "<unknown>"
    ],
    "visibility_condition": [
      "<unknown>"
    ],
    "allow_user_redeem": true,
    "value": "<string>",
    "type": "<string>",
    "campaign": "<string>",
    "external_id": "<string>",
    "same_campaign_count": 123
  }
}

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
period
integer
required
region_id
integer | null
currency
string | null
Pattern: ^[A-Z]+$
period_type
enum<string> | null
Available options:
days,
weeks,
months,
years,
absolute_date,
absolute_week,
absolute_month
absolute_expiry
string | null
description
string | null
internal_notes
string | null
meta
string[] | null
short_description
string | null
long_description
string | null
terms_conditions
string | null
earn_instructions
string | null
redeem_instructions_store
string | null
redeem_instructions_online
string | null
redeem_code_pos
string | null
redeem_code_online
string | null
icon
string<uri> | null
image_url
string<uri> | null
max_redemptions
integer | null
is_extendable
boolean | null
is_assignable
boolean | null
is_reassignable
boolean | null
end_at
string<date-time> | null
is_claimable
boolean | null
claim_period_start_at
string<date-time> | null
claim_period_end_at
string<date-time> | null
max_global_redemptions
integer | null
claim_condition
string[] | null
is_reclaimable
boolean | null
issue_target_id
integer | null
remind_target_id
integer | null
extend_target_id
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
force_allocation
boolean | null
is_published
boolean | null
is_archived
boolean | null
claim_timeframe
string[] | null
view_condition
string[] | null
visibility_condition
string[] | null
allow_user_redeem
boolean | null
value
number | null
campaign
string | null
type
enum<string> | null
Available options:
discount,
value,
competition,
event,
gift,
voucher,
bonus,
other
external_id
string | null
tags
string[]

Response

App.Http.Resources.BenefitDefinition

data
App.Http.Resources.BenefitDefinition · object
required