Incentive Code Redemption API Methods

Last Updated: Tuesday, June 15, 2021

Available API methods

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

Get Redemptions for an Incentive Code

GET /companies/:company_id/incentives/codes/:code/redemptions
Response

An array of all Redemptions for the given code.

Redeem an Incentive Code

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	No	Unique external issuee ID.
issuee_id	No	Vibes-generated issuee ID.
referring_application	No	Application redeeming the code.
referring_application_ref_id	No	Application 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.