Skip to main content
PUT
Edit Benefit Definition

Path Parameters

definition
string
required

The definition ID

Body

application/json
name
string
region_id
integer | null
currency
string | null
Pattern: ^[A-Z]+$
period
integer
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