Skip to main content
POST
/
perks
/
{perkId}
/
redeem
Redeem a perk for a user
curl --request POST \
  --url https://v2.api.us.housr.com/partners/perks/{perkId}/redeem \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_id": "<string>",
  "metadata": {}
}
'
{
  "id": "<string>",
  "perk_id": "<string>",
  "user_id": "<string>",
  "redeemed_at": "2023-11-07T05:31:56Z",
  "status": "approved",
  "metadata": {}
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

perkId
string
required

Body

application/json
user_id
string
required
metadata
object

Response

Redemption created

id
string
perk_id
string
user_id
string
redeemed_at
string<date-time>
status
enum<string>
Available options:
approved,
rejected,
pending
metadata
object