v1

latestOpenAPI 3.1.02026-07-24318141.2 MB

Debit Reward Item

Debit reward item points from a user profile

post/profiles/{profile_id}/reward-item-debits/

Path parameters

profile_idstring required

Request body

reward_item_idstring

reward_item_amountinteger

descriptionstring

Optional description for debiting this reward item. eg. purchased a signed cap at a discounted price

custom_datastring

String data to send with the reward debit. Typically contains a string JSON payload to be decoded by the client SDK

reasonstring

Optional reason for debiting this reward item. eg. merch purchase.

Response

200

idstring

new_balanceinteger

created_atstring

descriptionstring

custom_datastring

{"stackTrail":"paths:/profiles/{profile_id}/reward-item-debits/:post:responses:200:content:application/json:schema:properties:prizeout_balance","oasType":"schema","type":"unknown"}

reasonstring

Example response

{
  "id": "a9c7becd-ebf5-45d8-9cf1-99d7df1f114d",
  "new_balance": 91,
  "created_at": "2021-09-21T22:06:39.906193Z",
  "description": "purchased a signed cap at a discounted price",
  "custom_data": "{\"key\":\"key1\"}",
  "attributes": [
    {
      "key": "size",
      "value": "medium"
    }
  ],
  "reason": "merch purchase"
}