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 10 Next »

An Incentive Code entity is a single code that can be issued or redeemed.

Incentive Code Entity

The following is the JSON representation of an Incentive Code entity within the APIs.

Elements

{
  "code": "coupon01",
  "active": true,
  "issuances": {
    "total": 2,
    "unique": 1
  },
  "redemptions": {
    "total": 1,
    "unique": 1
  },
  "incentive_pool": {
    "id": 42,
    "url": "/companies/:id/incentives/pools/:pool_id"
  },
  "created_at: "2017-01-18T17:24:32Z",
  "updated_at: "2017-01-18T17:24:32Z",
  "url": "/companies/:id/incentives/codes/:code"
}

incentive_pool_id

Integer

Vibes unique identifier for each incentive pool.

code

String

The name of the incentive pool.

activeBooleanWhether issuance of codes is allowed.
issuancesObjectAn object describing this code's issuances.
issuances.totalIntegerThe total number of times this code has been issued.
issuances.uniqueIntegerThe number of unique times this code has been issued.
redemptionsObjectAn object describing this code's redemptions.
redemptions.totalIntegerThe total number of times this code has been redeemed.
redemptions.uniqueIntegerThe number of unique times this code has been redeemed.
created_atTimestampThe date this code was created.
updated_atTimestampThe date this code was last updated.
urlStringThe URL to access this resource.

Show an Incentive Code

GET /companies/:id/incentives/codes/:code
  • No labels