Skip to main content
POST
Claim a reward for a member

Authorizations

Authorization
string
header
required

Organization API key (org_...) sent as Authorization: Bearer <key>. Keys are scoped to one organization; every request operates within that tenant.

Headers

Idempotency-Key
string
required

Required. Tie it to one claim attempt.

Minimum string length: 1

Path Parameters

userId
string
required

Body

application/json
reward_id
string
required
Minimum string length: 1

Response

The claim, or the original claim replayed for a retried key

id
string
required
user_id
string
required
org_id
string
required
reward_id
string
required
amount
string
required

A non-negative integer as a decimal string.

status
enum<string>
required
Available options:
pending,
burned,
fulfilled,
failed
burn_ledger_entry_id
string | null
required
onchain_job_id
string | null
required
fulfilled_at
string<date-time> | null
required
code
string | null
required

The single-use code a code reward issued; null for every other reward.

code_used_at
string<date-time> | null
required

Null while the code is still usable.

created_at
string<date-time>
required