API Reference
Start typing to search…

Issue an incentive code

post https://public-api.vibescm.com/companies//incentives/pools//issuances

Pull an incentive code from an existing incentive pool and create an issuance entity for the selected code. If no codes are available from the code pool identified, an HTTP ERROR CODE 422 will be returned.

Log in to see full request history

Request

Please note that this request only creates an issuance entity; it does not actually deliver the code to an end user. Delivering the code to an end user is up to you.

When issuing a code, you must provide the pool that you want the code to come from. However, if you want to see the status or redeem a code, you only need to provide your company_id and code, and we'll figure out which pool the code comes from. This enables your redemption system to not worry about pools, and only check the validity of codes regardless of what pool they came from.

To learn more about incentive code pools, please see our Incentive Pool API.

📘

Reissuing codes by issuee_id

Note that you can’t issue a new code to the same issuee_id. The same code is issued for each issuee_id.

Path Params
string
required
string
required
Important: If you are entering a live issuance_pool_id, 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 issued.
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

No codes are available from the code pool specified.

Updated about 6 hours ago

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

Updated about 6 hours ago