API Reference

Redeem an incentive code

post
https://public-api.vibescm.com/companies//incentives/codes//redemptions

This POST method will redeem an incentive code, thus creating a redemption entity. If the code is successfully redeemed, the system will respond with the redemption entity that was just created.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
string
required
Important: If you are entering a real incentive_code, please note that using the "Try It" feature on the righthand console will send an actual API call to our system. This may result in a code being redeemed.
Body Params
string

Unique external issuee ID.

string

If provided, this specific code is issued.

string

Application issuing the code. Required in pools requiring a campaign_registration.

string

Application reference ID. Required in pools requiring a campaign_registration.

Headers
string
Defaults to 1
string
required
Responses

422

Returned in the following cases:

  • When using an invalid issuee_id or external_issuee_id.
  • When using a "unique" pool type, and the code has already been redeemed.</li

Updated about 1 year ago

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago