Sign in
Promotion Codes

Redeem a promotion code

Required scope: promotion-codes:write </br>Organization authorization: supported

post/api/v1/promotion-codes/redeem

Request body

promotionCodeIdinteger required

Promotion code id

userIdinteger required

Id of the user redeeming the code

teamIdinteger nullable

Id of the team (if applicable)

Example request

{
  "promotionCodeId": 1,
  "userId": 123,
  "teamId": 456
}

Response

Promotion code redeemed

promotionCodeIdinteger required

Id of the promotion code

userIdinteger required

Id of user using the promotion code

status'active' | 'scheduled' | 'expired' | 'inactive' required

Changes

No recorded changes to this endpoint across all 1 revision of this API.