An incentive pool entity is entity that contains information about a pool from which you can pull individual incentive codes. Using methods such as POST and GET, you can create, edit, and manage your incentive pools with the Incentive Pool API.

Available API Methods

Elements & Attributes

Data Element	Type	Max Char Length	Description
`id`	Integer	20	A unique identifier for each incentive pool. This is automatically generated by the Vibes system.
`name`	String		The name of the incentive pool, as defined by you. We recommend naming it something unique that you’ll remember.
`issuance_allowed`	Boolean		Whether issuance of codes is allowed. Setting this to false will prevent codes from being issued from this particular pool.
`redemption_allowed`	Boolean		Whether redemption of codes is allowed. Setting this to false will prevent codes from this particular pool from being redeemed.
`incentive_codes`	Object		An object describing this pool's incentive codes.
`incentive_codes.total`	Integer		Total number of incentive codes in the pool.
`incentive_codes.remaining`	Integer		Remaining number of available incentive codes in the pool.
`incentive_codes.low_threshold`	Integer		A number at which, if the available incentive codes is equal or less than, a notification is indicating a low number of available codes.
`incentive_codes.max_characters`	Integer		The maximum number of characters allowed in an incentive code in this pool.
`distribution`	Object		An object describing this pool's distribution type.
`distribution.method`	String	10	The method of distribution (unique\|multi).
`notification_email_address`	String		The email address for all notifications.
`created_at`	Timestamp	20	The date this pool was created. It should be in the ISO 8601 format - for example: 2017-01-01T12:00Z.
`updated_at`	Timestamp	20	The date this pool was last updated. It should be in the ISO 8601 format - for example: 2017-04-07T12:00Z.
`url`	String	50	The URL to access this resource.

Example Entity

The following is the JSON representation of an incentive pool entity.

{
  "id": 42,
  "name": "Store Coupons",
  "issuance_allowed": true,
  "redemption_allowed": true,
  "incentive_codes": {
    "total": 500,
    "issued": 143,
    "remaining": 357,
    "low_threshold": 100,
    "max_characters": 50
  },
  "distribution": {
    "method": "unique"
  },
  "notification_email_address": "[email protected]",
  "created_at":"2017-01-01T12:00Z",
  "updated_at":"2017-04-07T12:00Z",
  "url":"/companies/:company_id/incentives/pools/:pool_id"
}