Platform Developer Documentation

Versions Compared

Old Version 29

changes.mady.by.user Unknown User (laura.puckett)

Saved on

compared with

New Version Current

changes.mady.by.user Bill Shampton

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Last Updated:

Lastupdatedate

Livesearch
placeholderSearch the Vibes Developer Wiki
typepage

Available API methods

Table of Contents
maxLevel3


An Incentive Pool entity is a collection of Incentive Codes.

Get Incentive Pools

Code Block
GET /companies/:company_key/incentives/pools

Response

An array of all Incentive Pools for the given company.

Show an Incentive Pool

Code Block
GET /companies/:company_key/incentives/pools/:pool_id

Create an Incentive Pool

Code Block
POST /companies/:company_key/incentives/pools
{
  "name": "Test Pool",
  "issuance_allowed": true,
  "redemption_allowed": true,
  "incentive_codes": {
    "low_threshold": 1000,
    "max_characters": 10
  },
  "distribution": {
    "method": "unique"
  },
  "notification_email_address": "your.name@your.company.com"
}

Update an Incentive Pool

Code Block
PUT /companies/:company_key/incentives/pools/:pool_id
{
  "name": "Test Pool",
  "issuance_allowed": true,
  "redemption_allowed": true,
  "incentive_codes": {
    "low_threshold": 1000,
    "max_characters": 10
  },
  "distribution": {
    "method": "unique"
  },
  "notification_email_address": "your.name@your.company.com"
}