Versions Compared

Key

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

Last Updated:

Lastupdatedate

Livesearch
placeholderSearch the Vibes Developer Wiki
typepage



An Incentive Code Redemption entity is a record of a Redemption of an Incentive Code.

Anchor
getredemptionsforanincentivecode
getredemptionsforanincentivecode
Get Redemptions for an Incentive Code


Code Block
GET /companies/:company_id/incentives/codes/:code/redemptions

Response

An array of all Redemptions for the given code.

Anchor
redeemanincentivecode
redeemanincentivecode
Redeem an Incentive Code

Code Block
POST /companies/:company_id/incentives/codes/:code/redemptions
{
  "external_issuee_id": "312",
  "issuee_id": "1234-5678",
  "referring_application": "system",
  "referring_application_ref_id" : "1234"  
}

Request Elements

Data Element
Required
Description

external_issuee_id

NoUnique external issuee ID.
issuee_idNoVibes-generated issuee ID.

referring_application

NoApplication issuing redeeming the code.

referring_application_ref_id

NoApplication reference ID.

Response

It returns a Redemption entity if the code was successfully redeemed.

An HTTP 422 error code is returned in the following cases:

  • When using an invalid issuee_id or external_issuee_id.
  • When using a 'unique' pool type, and the code has already been redeemed.