Skip to main content
PUT
cURL

Authorizations

x-tenant-key
string
header
required

Tenant API key

Headers

X-Tenant-Signature
string
required

Hex HMAC-SHA256 of the timestamp, the uppercase method, the url as sent and the request body, keyed by the signing secret.

X-Tenant-Timestamp
string
required

Unix seconds. Checked before the signature.

X-Idempotency-Key
string<uuid>
required

Unique key for this write. A replay returns the stored response; the same key with a different body conflicts.

Path Parameters

rewardId
string
required

Body

application/json
description
string
is_active
boolean

Visibility/redeemability flag. This is the only reward field mutable after publish.

metadata
object

Freeform reward metadata (full-replace of the jsonb on update). May carry a tenant-scoped image_key; any client-supplied image_url is rejected — the URL is derived on read.

min_tier_id
string | null

Tier gate — UUID of the minimum tier, or ''/null to clear (all tiers).

status
enum<string>
Available options:
initialized,
published
title
string
xp_cost
number<double>

Response

success
boolean
required
data
object
errors
object[]
message
string