v1

latestOpenAPI 3.0.02026-07-267581167.5 KB

Incentive Code API

Issue an incentive code

post/companies/{company_key}/incentives/pools/{issuance_pool_id}/issuances

Path parameters

company_keystring required

issuance_pool_idstring required

<div style="color:#dd1e2e; background:url(https://d2xs7zaan7w9gl.cloudfront.net/data/pages/64014/widgets/48027d01-e827-45e0-b96d-227c1099eedc/image/1680214872.png?icon-24x24-warning.png) no-repeat 10px center; background-color:#FCEAEC; padding:10px; font-size:13px;"><div style="padding-left:35px"><b>Important:</b> If you are entering a live issuance_pool_id, please note that using the <b>"Try It"</b> feature on the righthand console will send an actual API call to our system. This may result in a code being issued.</div></div>

Headers

X-API-Versionstring

Content-Typestring required

Request body

external_issuee_idstring

Unique external issuee ID.

codestring

If provided, this specific code is issued.

referring_applicationstring

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

referring_application_ref_idstring

Application reference ID. Required in pools requiring a campaign_registration.

Response

Successful response

idinteger

Vibes unique identifier for each issuance.

external_issuee_idstring

Unique external issuee ID.

issuee_idstring

Vibes generated issuee ID.

referring_applicationstring

Application issuing the code.

referring_application_ref_idstring

Application reference ID (campaign ID).

created_atstring

The date this issuance was created, in the ISO-8601 format.

updated_atstring

The date this issuance was last updated, in the ISO-8601 format.