---
title: "Redeem an incentive code"
method: POST
path: "/companies/{company_key}/incentives/codes/{incentive_code}/redemptions"
tags: ["Incentive Code API"]
---

# Redeem an incentive code

`POST /companies/{company_key}/incentives/codes/{incentive_code}/redemptions`

## Request

- Base URL: `https://public-api.vibescm.com`
- URL: `https://public-api.vibescm.com/companies/{company_key}/incentives/codes/{incentive_code}/redemptions`
- Auth: HTTP basic

## Path parameters

- `company_key` string, required
- `incentive_code` string, required

## Headers

- `X-API-Version` string
- `Content-Type` string, required

## Request body

- IncentiveCodeIssuanceRequest
  - `external_issuee_id` string: Unique external issuee ID.
  - `code` string: If provided, this specific code is issued.
  - `referring_application` string: Application issuing the code. Required in pools requiring a campaign_registration.
  - `referring_application_ref_id` string: Application reference ID. Required in pools requiring a campaign_registration.

## Response `200`

Successful response

- IncentiveCodeIssuanceResponse[]
  - `id` integer: Vibes unique identifier for each issuance.
  - `external_issuee_id` string: Unique external issuee ID.
  - `issuee_id` string: Vibes generated issuee ID.
  - `referring_application` string: Application issuing the code.
  - `referring_application_ref_id` string: Application reference ID (campaign ID).
  - `incentive_code` object: An object describing this Issuance's Incentive Code.
    - `code` string: The incentive code.
    - `url` string: The incentive code's resource URL.
  - `incentive_pool` object: An object describing this issuance's Pool.
    - `id` integer: The unique identifier for the pool.
    - `url` integer: The URL to access the incentive pool resource.
  - `created_at` string: The date this issuance was created, in the ISO-8601 format.
  - `updated_at` string: The date this issuance was last updated, in the ISO-8601 format.

## Other responses

- `422`: Returned in the following cases:<br> <ul> <li>When using an invalid issuee_id or external_issuee_id.</li> <li>When using a "unique" pool type, and the code has already been redeemed.</li </ul>

---

[API](https://skmtc.dev/vibes/apis/vibes-platform-api.md) - [All operations](https://skmtc.dev/vibes/apis/vibes-platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vibes/apis/vibes-platform-api/revisions/e235838f2e50?raw)