TagMango Documentation

Edit one of your existing coupons by its code. Every field in the body is optional and only touches what you send — omitted fields are left unchanged. code, currency, and type cannot be changed directly — type is always derived from mangoes (see that field's description). Setting percentageDiscount always clears any flatDiscount already on the coupon. A coupon linked to a sale cannot be edited here. Every successful edit reactivates the coupon (active is always set to true) — use the deactivate endpoint to turn one off. Changing mangoes, a discount field, startAt/validTill, or targetMangoes/targetUsers re-runs the same checks coupon creation does — mango eligibility, mango-currency consistency (every mango must be priced in the coupon's own, immutable currency), the plan-based discount cap, the 5-minute validTill/startAt gap, and the target-user subscription check — validated against whichever side of each check you are not touching in this request (the coupon's current stored value). Fields you leave out of the request are never re-validated.

Authorization

bearer

AuthorizationBearer <token>

In: header

Path Parameters

code*string

The coupon code to edit (case-insensitive).

Header Parameters

x-whitelabel-host*string

Host name of the dashboard, ex: mydomain.tagmango.com

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

mangoes?array<>

Replaces the mango ids this coupon can be redeemed on. Every id given must belong to this creator, must be one-time-priced — a free, zero-cost, open-ended, or recurring (subscription) mango is rejected — and must be priced in the coupon's own currency (currency itself is not editable). Send an empty array to move the coupon to creator-wide (clears the mango scope entirely) — omit the field to leave it unchanged. Also updates the coupon's type in the response to match — non-empty -> mango_coupon, empty -> creator_discount_coupon — this is derived automatically and cannot be set directly. Omitting mangoes entirely leaves the stored type as-is.

startAt?string

When the coupon becomes redeemable. A full ISO 8601 date-time — YYYY-MM-DDTHH:mm:ss.sssZ — not a bare date; the time-of-day matters, control is at minute precision.

Formatdate-time

validTill?string

When the coupon expires. Same full ISO 8601 date-time format as startAt. If given, must be after now. Either way, the resulting startAt/validTill pair — using the coupon's existing stored value for whichever side you did not send — must be at least 5 minutes apart by actual elapsed time (e.g. 10:00:00Z to 10:05:00Z is the minimum gap; 10:03:00Z is rejected even though it is "after" startAt) — not just on different calendar days.

Formatdate-time

flatDiscount?number

Flat amount off, in the coupon’s existing currency (currency itself is not editable). Must be greater than 0. If percentageDiscount is also given (here or already stored), it takes priority and this is dropped from the coupon entirely — conversely, setting this always clears any percentageDiscount already on the coupon, so the two can never coexist after an edit. Without the 100%-discount plan entitlement, capped at 80% of the cheapest priced mango this coupon applies to (whichever of mangoes or the coupon's existing mango scope is in effect) — with it, the mango's full price.

percentageDiscount?number

Percentage off, greater than 0 and at most 100. Setting this always clears any flatDiscount already on the coupon, so the two can never coexist after an edit. Without the 100%-discount plan entitlement, capped at 80%.

remainingOrder?number

How many times this coupon can still be redeemed. The stored value decrements by 1 automatically on every successful redemption — setting it here overwrites that count directly, it is not reconciled against how many times the coupon has already been used (totalUsage, read-only). Pushing it back up restores already-used redemption slots.

targetMangoes?array<>

Replaces the redemption-eligibility mango gate. If you send either this or targetUsers, the resulting pair — using the coupon's existing stored value for whichever side you did not send — is re-validated: targetUsers requires a non-empty targetMangoes, and every targetUsers id must have an active subscription to one of them.

targetUsers?array<>

Replaces the redemption user allow-list. See targetMangoes — sending either field re-validates the resulting pair against the coupon's existing stored value for whichever side you did not send.

Response Body

`application/json`

curl -X PUT "https://api-prod-new.tagmango.com/api/v1/external/coupons/WELCOME50" \  -H "x-whitelabel-host: string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "_id": "66a1390268a76f2f5c9f39a3",
  "code": "WELCOME50",
  "type": "creator_discount_coupon",
  "creator": "77b2390268a76f2f5c9f39a4",
  "startAt": "2024-08-11T10:20:30Z",
  "validTill": "2024-12-31T23:59:59Z",
  "active": true,
  "flatDiscount": 100,
  "percentageDiscount": 10,
  "remainingOrder": 50,
  "totalUsage": 5,
  "currency": "INR",
  "createdAt": "2024-08-11T10:20:30Z",
  "updatedAt": "2024-08-11T10:20:30Z",
  "mangoes": [
    "64fbc8d765c6e5b324d45678"
  ],
  "targetMangoes": [
    "64fbc8d765c6e5b324d45678"
  ],
  "targetUsers": [
    "64fbc8d765c6e5b324d67890"
  ]
}

{
  "code": 400,
  "type": "Bad Request",
  "statusMessage": "BAD_REQUEST",
  "errorCode": "COUPON_MANGO_NOT_ELIGIBLE",
  "message": "A coupon can only target a one-time-priced mango — free, zero-cost, open-ended, and recurring (subscription) mangoes can never redeem a coupon, so one cannot be created for them.",
  "result": "A coupon can only target a one-time-priced mango — free, zero-cost, open-ended, and recurring (subscription) mangoes can never redeem a coupon, so one cannot be created for them.",
  "success": false
}

{
  "code": 401,
  "type": "Unauthorized",
  "statusMessage": "UNAUTHORIZED",
  "message": "Invalid token",
  "result": "Invalid token",
  "success": false
}

{
  "code": 403,
  "type": "Forbidden",
  "statusMessage": "FORBIDDEN",
  "errorCode": "COUPON_SALE_LINKED_NOT_EDITABLE",
  "message": "A coupon created as part of a sale/sale-item cannot be edited through this endpoint.",
  "result": "A coupon created as part of a sale/sale-item cannot be edited through this endpoint.",
  "success": false
}

{
  "code": 404,
  "type": "Not Found",
  "statusMessage": "NOT_FOUND",
  "errorCode": "COUPON_NOT_FOUND",
  "message": "No coupon with this code exists among your own coupons.",
  "result": "No coupon with this code exists among your own coupons.",
  "success": false
}

{
  "code": 429,
  "type": "Too Many Requests",
  "statusMessage": "TOO_MANY_REQUESTS",
  "message": "Request limit exceeded. try after 10 seconds",
  "result": "Request limit exceeded. try after 10 seconds",
  "success": false
}

Edit Coupon

Authorization

Path Parameters

Header Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

429application/json

COUPON_MANGO_NOT_ELIGIBLE

COUPON_CURRENCY_MISMATCH

COUPON_INVALID_PERCENTAGE_DISCOUNT

COUPON_INVALID_DATE_RANGE

COUPON_TARGET_USERS_REQUIRE_TARGET_MANGOES

COUPON_TARGET_USER_NOT_SUBSCRIBED

COUPON_SALE_LINKED_NOT_EDITABLE

COUPON_MANGOES_FORBIDDEN

COUPON_TARGET_MANGOES_FORBIDDEN

COUPON_DISCOUNT_CAP_EXCEEDED

COUPON_NOT_FOUND

COUPON_MANGOES_NOT_FOUND

COUPON_TARGET_MANGOES_NOT_FOUND

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`