v1

latestOpenAPI 3.0.02026-07-267581167.5 KB

Incentive Pool API

Update an existing pool

put/companies/{company_key}/incentives/pools/{incentive_pool_id}

Path parameters

company_keystring required

incentive_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 incentive_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 changes being made to the live code pool.</div></div>

Headers

X-API-Versionstring

Content-Typestring required

Request body

namestring required

The name given to the incentive pool.

issuance_allowedboolean required

Indicates whether codes are currently allowed to be issued from this code pool.

redemption_allowedboolean required

Indicates whether codes from this code pool are currently allowed to be redeemed.

notification_email_addressstring required

The email address for all notifications.

Response

Successful response

idinteger

Vibes unique identifier for each incentive pool.

namestring

The name of the incentive pool.

issuance_allowedboolean

Indicates whether codes are currently allowed to be issued from this code pool.

redemption_allowedboolean

Indicates whether codes from this code pool are currently allowed to be redeemed.

notification_email_addressstring

The email address you'd like notifications about this code pool to be send to.

created_atstring

The date this pool was created in ISO-8601 format.

updated_atstring

The date this pool was last updated in ISO-8601 format.

urlstring