Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

Contents

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/:id/incentives/pools/:pool_id

Create an Incentive Pool

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

Request Elements

Data ElementRequiredDescription

name

YesThe name for the incentive pool
issuance_allowedNo

Whether this pool can issue codes.

redemption_allowed

NoWhether codes in this pool can be redeemed.

incentive_codes

NoAn object describing incentive code properties.
incentive_codes.low_thresholdNoThe threshold for available codes notifications.
incentive_codes.max_charactersNoThe maximum length of each incentive code.
notification_email_addressNoThe email address for all notifications.

Update an Incentive Pool

PUT /companies/: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"
}

Request Elements

Data ElementRequiredDescription

name

YesThe name for the incentive pool
issuance_allowedNo

Whether this pool can issue codes.

redemption_allowed

NoWhether codes in this pool can be redeemed.

incentive_codes

NoAn object describing incentive code properties.
incentive_codes.low_thresholdNoThe threshold for available codes notifications.
incentive_codes.max_charactersNoThe maximum length of each incentive code.
notification_email_addressNoThe email address for all notifications.
  • No labels