Skip to main content
PATCH
Update a reward

Authorizations

Authorization
string
header
required

API key from the Rigaly dashboard: Authorization: Bearer rgly_sk_...

Path Parameters

id
string<uuid>
required

Body

application/json
name
string
Example:

"Free Coffee"

description
string | null
points_cost
integer
Required range: x >= 0
Example:

500

active
boolean
default:true
start_date
string<date> | null
end_date
string<date> | null
time_active
object

Per-day time-of-day windows. Omit a day to leave it unrestricted; omit the whole field for always-active.

Example:
conditions
string | null

Free-text conditions shown to customers and returned on validation — use it to encode product restrictions your system enforces.

Maximum string length: 1000
cooldown_mode
enum<string>
default:none
Available options:
none,
limit,
once
cooldown_count
integer | null
cooldown_amount
integer | null
cooldown_unit
enum<string> | null
Available options:
minute,
hour,
day,
month
birthday
boolean
default:false

Response

Reward updated

success
boolean
Example:

true

message
string
data
object