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 Element | Required | Description |
|---|---|---|
name | Yes | The name for the incentive pool |
| issuance_allowed | No | Whether this pool can issue codes. |
redemption_allowed | No | Whether codes in this pool can be redeemed. |
incentive_codes | No | An object describing incentive code properties. |
| incentive_codes.low_threshold | No | The threshold for available codes notifications. |
| incentive_codes.max_characters | No | The maximum length of each incentive code. |
| notification_email_address | No | The 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 Element | Required | Description |
|---|---|---|
name | Yes | The name for the incentive pool |
| issuance_allowed | No | Whether this pool can issue codes. |
redemption_allowed | No | Whether codes in this pool can be redeemed. |
incentive_codes | No | An object describing incentive code properties. |
| incentive_codes.low_threshold | No | The threshold for available codes notifications. |
| incentive_codes.max_characters | No | The maximum length of each incentive code. |
| notification_email_address | No | The email address for all notifications. |
Overview
Content Tools