Contents
Show an Incentive Code
GET /companies/:id/incentives/codes/:code
Redeem an Incentive Code
POST /companies/:id/incentives/codes/:code/redemptions
Request body
{
"external_issuee_id": "312",
"issuee_id": "1234-5678",
"referring_application": "splat",
"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 issuing the code. |
referring_application_ref_id | No | Application reference id. |
Response
It returns a redemption entity if the code was successfully redeemed.
An HTTP error code 422 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.
Overview
Content Tools