---
title: "Update coupon redeem field"
method: PUT
path: "/coupon/redeem"
---

# Update coupon redeem field

`PUT /coupon/redeem`

## Request body

- object
  - `redemptions` object — Object containing redemption details.
  - `redemptionId` integer, required — Unique identifier of the redemption.
  - `billAmount` integer, required — The amount of the bill associated with the redemption.
  - `transactionNumber` string — Unique number identifying the transaction.
  - `billId` integer — Unique identifier for the bill associated with redemption.
  - `user` object — An object representing the user.
  - `mobile` string — The mobile number of the user.

## Response `200`

200

- union
  - object
    - `entity` object
      - `redemptions` object[]
        - `redemptionId` integer
        - `billAmount` integer
        - `transactionNumber` string
        - `billId` integer
        - `customFields` object
          - `cf_key_1` string
          - `cf_key_2` string
        - `redemptionStatus` object
          - `status` boolean
          - `code` integer
          - `message` string
      - `user` object
        - `id` integer
        - `profiles` object[]
          - `firstName` string
          - `lastName` string
          - `fields` object
          - `allFields` object
          - `identifiers` object[]
            - `type` string
            - `value` string
          - `commChannels` unknown[]
            - unknown
          - `userId` integer
          - `accountId` string
          - `autoUpdateTime` string
          - `identifiersAll` object[]
            - `type` string
            - `value` string
      - `status` object
        - `status` boolean
        - `code` integer
        - `message` string
      - `totalCount` integer
      - `failedCount` integer
    - `warnings` unknown[]
      - unknown
    - `errors` object[]
      - `status` boolean
      - `code` integer
      - `message` string
    - `success` boolean
  - object
    - `entity` object
      - `redemptions` object[]
        - `redemptionId` integer
        - `billAmount` integer
        - `transactionNumber` string
        - `billId` integer
        - `redemptionStatus` object
          - `status` boolean
          - `code` integer
          - `message` string
      - `user` object
        - `id` integer
        - `profiles` object[]
          - `firstName` string
          - `lastName` string
          - `fields` object
          - `allFields` object
          - `identifiers` object[]
            - `type` string
            - `value` string
          - `commChannels` unknown[]
            - unknown
          - `userId` integer
          - `accountId` string
          - `autoUpdateTime` string
          - `identifiersAll` object[]
            - `type` string
            - `value` string
      - `status` object
        - `status` boolean
        - `code` integer
        - `message` string
      - `totalCount` integer
      - `failedCount` integer
    - `warnings` unknown[]
      - unknown
    - `errors` unknown[]
      - unknown
    - `success` boolean
  - object
    - `entity` object
      - `redemptions` object[]
        - `redemptionId` integer
        - `billAmount` integer
        - `billId` integer
        - `redemptionStatus` object
          - `status` boolean
          - `code` integer
          - `message` string
      - `user` object
        - `id` integer
        - `profiles` object[]
          - `firstName` string
          - `lastName` string
          - `fields` object
          - `allFields` object
          - `identifiers` object[]
            - `type` string
            - `value` string
          - `commChannels` unknown[]
            - unknown
          - `userId` integer
          - `accountId` string
          - `autoUpdateTime` string
          - `identifiersAll` object[]
            - `type` string
            - `value` string
      - `status` object
        - `status` boolean
        - `code` integer
        - `message` string
      - `totalCount` integer
      - `failedCount` integer
    - `warnings` unknown[]
      - unknown
    - `errors` unknown[]
      - unknown
    - `success` boolean
  - object
    - `entity` object
      - `redemptions` object[]
        - `redemptionId` integer
        - `billAmount` integer
        - `billId` integer
        - `redemptionStatus` object
          - `status` boolean
          - `code` integer
          - `message` string
      - `user` object
        - `id` integer
        - `profiles` object[]
          - `firstName` string
          - `lastName` string
          - `fields` object
          - `allFields` object
          - `identifiers` object[]
            - `type` string
            - `value` string
          - `commChannels` unknown[]
            - unknown
          - `userId` integer
          - `accountId` string
          - `autoUpdateTime` string
          - `identifiersAll` object[]
            - `type` string
            - `value` string
      - `status` object
        - `status` boolean
        - `code` integer
        - `message` string
      - `totalCount` integer
      - `failedCount` integer
    - `warnings` unknown[]
      - unknown
    - `errors` unknown[]
      - unknown
    - `success` boolean
  - object
    - `entity` object
      - `redemptions` object[]
        - `redemptionId` integer
        - `billAmount` integer
        - `billId` integer
        - `customFields` object
          - `PNR-1` string
          - `PNR-2` string
        - `redemptionStatus` object
          - `status` boolean
          - `code` integer
          - `message` string
      - `user` object
        - `id` integer
        - `profiles` object[]
          - `firstName` string
          - `lastName` string
          - `fields` object
          - `allFields` object
          - `identifiers` object[]
            - `type` string
            - `value` string
          - `commChannels` unknown[]
            - unknown
          - `userId` integer
          - `accountId` string
          - `autoUpdateTime` string
          - `identifiersAll` object[]
            - `type` string
            - `value` string
      - `status` object
        - `status` boolean
        - `code` integer
        - `message` string
      - `totalCount` integer
      - `failedCount` integer
    - `warnings` unknown[]
      - unknown
    - `errors` unknown[]
      - unknown
    - `success` boolean

## Other responses

- `400` — 400

---

[API](https://skmtc.net/capillarytech/apis/sample-api.md) · [All operations](https://skmtc.net/capillarytech/apis/sample-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/capillarytech/sample-api/versions/de241f2ed9b3/schema)