Brivio API reference
Rewards

Redeem a catalogue item for a member; units are burnt at once, above the auto-approve threshold the redemption waits for your approval. 409 insufficient_units / in_debt (scope: rewards:write)

POST
/rewards/members/{ref}/redemptions

Authorization

bearerAuth
headerAuthorizationBearer <token>

API key as Bearer token

Path Parameters

ref*string

customer:<uuid> for an end customer of your organization, otherwise your own external id (URL-encode it).

Lengthlength <= 200

Header Parameters

Idempotency-Key?string

Required. Retries with the same key replay the first response instead of starting a second job (24 h).

Lengthlength <= 200

Request Body

application/json
  1. body
catalogKey*string
Lengthlength <= 120

Response Body

OK

application/json
  1. response
data*
error*null
curl -X POST "https://example.com/rewards/members/string/redemptions" \  -H "Content-Type: application/json" \  -d '{    "catalogKey": "string"  }'
{  "data": {    "id": 0,    "status": "pending_approval",    "duplicate": true  },  "error": null}

Record a business event and process it inline; payload.units is the award. Idempotency-Key (or type+ref+member) dedupes (scope: rewards:write) POST

Previous Page

Create a widget signing key; the secret is returned once (scope: rewards:write) POST

Next Page