---
title: "Create redemption"
method: POST
path: "/api-offers/redemption"
tags: ["Redemption"]
---

# Create redemption

`POST /api-offers/redemption`

## Request

- Base URL: `https://live.copilot.fabric.inc`
- URL: `https://live.copilot.fabric.inc/api-offers/redemption`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/fabric/apis/offers-v2/docs/api-offers/redemption/post.ts> (a function with typed inputs; its response is checked against the schema)

Enables you to create a redemption record

## Headers

- `x-site-context` string, required

## Request body

- NewRedemptionRequest
  - `promoId` string, required: fabric database objectId of the promotion to redeem, received from promotion structure
  - `promoCode` string, nullable: promoCode of the coupon that is redeemed, could be null if no promoCode available
  - `userId` string, nullable: ID of the user who redeem the promotion, could be null if no user ID available
  - `email` string: Email address of the user who redeem the promotion
  - `orderId` string, required: Order ID of this purchase

## Response `200`

OK

- Redemption
  - `_id` string: fabric internal ID
  - `promoId` string: fabric database objectId of the promotion to redeem
  - `promoCode` string: promoCode of the coupon that is redeemed
  - `userId` string: ID of the user who redeem the coupon
  - `email` string: Email address of the user who redeem the coupon
  - `orderId` string: Order ID of this purchase
  - `createdAt` string, date-time: Creation date of the record
  - `updatedAt` string, date-time: Last updated date of the record

## Other responses

- `400`: Bad Request
- `500`: Internal Server Error

---

[API](https://skmtc.dev/fabric/apis/offers-v2.md) - [All operations](https://skmtc.dev/fabric/apis/offers-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/fabric/apis/offers-v2/revisions/da2bd742b9bc?raw)