Update an existing pool

put

https://public-api.vibescm.com/companies/{company_key}/incentives/pools/{incentive_pool_id}

Update an existing incentive pool. For example, if you’d like to stop allowing an incentive pool from issuing codes, you can use the PUT method to change the issuance_allowed to false.

Path Params

company_key

string

required

incentive_pool_id

string

required

Important: If you are entering a live incentive_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 changes being made to the live code pool.

Body Params

name

string

required

The name given to the incentive pool.

issuance_allowed

boolean

required

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

redemption_allowed

boolean

required

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

incentive_codes

object

required

distribution

object

required

notification_email_address

string

required

The email address for all notifications.

Headers

X-API-Version

string

Defaults to 1

Content-Type

string

required

Response

Language

Credentials

Basic

base64

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response