Skip to end of metadata
Go to start of metadata

Last Updated: Monday, January 7, 2019



An Incentive Pool entity is a collection of Incentive Codes.

Get Incentive Pools

GET /companies/:id/incentives/pools

Response

An array of all Incentive Pools for the given company.

Show an Incentive Pool

GET /companies/:company_id/incentives/pools/:pool_id

Create an Incentive Pool

POST /companies/:company_id/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

PUT /companies/:company_id/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"
}
  • No labels