TagMango Documentation

Partially updates one active Mango owned by the authenticated creator. The path mangoId is authoritative; _id is not a request field. Unknown request fields, including createChatroom, are stripped by the external v1 validation pipeline. Chat-room creation remains create-only.

Presence and clearing: Omitted top-level fields and omitted nested leaves preserve their stored values. false and 0 are real replacements. Arrays such as coverContents replace atomically, so [] clears the list. Nullable per-currency prices, pricing.strikeThrough, validity, trial, billing-cap, seat-limit, and seat-label fields accept null to clear. Titles, descriptions, arrays, type/frequency, base price, settings booleans, access.startsAt, and access.allowMultipleQuantity do not accept null. Provide at most one of description and descriptionHtml; either supplied form updates both returned representations.

Immutable fields: Mango type and access.startsAt are immutable. For recurring Mangoes, recurringType, base price, per-currency prices, currency, settings.includeGST, and settings.priceIncludesGST are also immutable because payment mandates already exist. These fields may be included for round-tripping only when equal to the current detail. One-time price, differential pricing, GST configuration, and strike-through pricing remain editable.

Merged validation: The API validates the resulting full Mango before any mutation. This includes coupon compatibility, creator feature entitlements, payment-mode conflicts and reset requirements, type-specific fields, relationship ownership/sharing, offshore postal-field retention, media URLs, and a new seat limit against the live active-subscriber count.

Effects and retries: Actual title changes update the room title and slug; actual intro-video changes queue thumbnail generation; an explicitly changed one-time price notifies a shared funnel; only newly added video covers are submitted for transcoding; and badge caches are invalidated only for an actual persisted change. Durable submissions are awaited, but downstream processing is asynchronous. The workflow intentionally preserves the legacy non-transactional boundary: a provider failure can occur after an earlier effect and before Mango persistence. There is no idempotency key, revision token, or transaction, so concurrent updates are last-write-wins and a retry after partial failure can repeat an earlier effect.

Authorization

bearer

AuthorizationBearer <token>

In: header

Path Parameters

mangoId*string

The 24-character hexadecimal ID of the owned Mango addressed by this operation. Obtain it from List Mangoes or the result._id returned by Create Mango.

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.

title?string

Replacement service title. HTML tags are stripped.

Lengthlength <= 100

description?string

Replacement plain-text description. Provide at most one of description and descriptionHtml.

descriptionHtml?string

Replacement rich HTML description. Provide at most one of description and descriptionHtml.

coverContents?array<>

Replacement cover URL list. [] clears all covers. At most 10 absolute URLs are accepted, ending in JPG, JPEG, PNG, WebP, GIF, MP4, or WebM.

Itemsitems <= 10

type?string

Service pricing model accepted only when unchanged.

Value in"onetime" | "recurring" | "free"

currency?string

Primary checkout currency. Editable for one-time Mangoes; accepted on recurring Mangoes only when unchanged.

Value in"USD" | "INR" | "EUR"

price?number

Replacement base selling price in the creator's currency. One-time pricing is editable; recurring pricing is accepted only when unchanged.

recurringType?string

onetime or a recurring billing interval accepted for round-tripping only when unchanged; frequency is immutable.

Value in"monthly" | "onetime" | "yearly" | "quarterly" | "halfyearly"

differentialPricing?

Sparse per-currency replacements. Supplied null leaves clear that override; omitted leaves are preserved.

pricing?

Sparse display-pricing changes. Omitted leaves are preserved and documented nullable values are cleared.

settings?

Sparse checkout-setting changes. Omitted leaves are preserved; boolean leaves reject null.

access?

Sparse access changes. Omitted leaves are preserved and documented nullable leaves may be cleared.

Response Body

`application/json`

curl -X PATCH "https://api-prod-new.tagmango.com/api/v1/external/mangos/6a8ec3908384d1f9507e7c2c" \  -H "x-whitelabel-host: string" \  -H "Content-Type: application/json" \  -d '{    "access": {      "seatLimit": null    },    "differentialPricing": {      "usd": 15    },    "price": 1199,    "settings": {      "includeGST": true,      "priceIncludesGST": true    }  }'

{
  "code": 200,
  "result": {
    "_id": "66a1390268a76f2f5c9f39a3",
    "creator": "77b2390268a76f2f5c9f39a4",
    "title": "Premium Fitness Course",
    "description": "A 12-week fitness transformation program.",
    "descriptionHtml": "<p>A <strong>12-week</strong> fitness transformation program.</p>",
    "price": 1180,
    "currency": "INR",
    "inrAmount": 999,
    "usdAmount": 12,
    "eurAmount": 11,
    "isDeleted": false,
    "isHidden": false,
    "recurringType": "onetime",
    "isPublic": true,
    "isFree": true,
    "zeroCostMango": true,
    "affiliateEnabled": true,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "coverContents": [
      "https://cdn.example.com/cover.webp"
    ],
    "checkoutLink": "https://creator.example.com/web/checkout/66a1390268a76f2f5c9f39a3?purchaseNow=true",
    "shortLink": "https://creator.example.com/l/premium-fitness",
    "type": "onetime",
    "differentialPricing": {
      "inr": 999,
      "usd": 12,
      "eur": 11
    },
    "settings": {
      "includeGST": false,
      "priceIncludesGST": false,
      "otpless": false,
      "showTdsField": false
    },
    "pricing": {
      "strikeThrough": {
        "inr": 1499,
        "usd": 18,
        "eur": 16
      }
    },
    "access": {
      "startsAt": "2026-09-01T10:00:00.000Z",
      "validityDays": 365,
      "trialDays": 7,
      "maxBillingCycles": 12,
      "seatLimit": 100,
      "seatLabel": "Seats remaining",
      "allowMultipleQuantity": false
    }
  },
  "type": "Success",
  "message": "Mango fetched successfully",
  "statusMessage": "OK",
  "success": true
}

{
  "code": 400,
  "type": "Bad Request",
  "statusMessage": "BAD_REQUEST",
  "errorCode": "REMOTE_MEDIA_TOO_MANY_ITEMS",
  "message": "A request may contain at most 10 remote Mango media items.",
  "result": "A request may contain at most 10 remote Mango media items.",
  "success": false
}

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

{
  "code": 403,
  "type": "Forbidden",
  "statusMessage": "FORBIDDEN",
  "errorCode": "WORKSHOP_MANGO_FORBIDDEN",
  "message": "You can not access this api with a TagMango account, only available for whitelabel hosts",
  "result": "You can not access this api with a TagMango account, only available for whitelabel hosts",
  "success": false
}

{
  "code": 404,
  "type": "Not Found",
  "statusMessage": "NOT_FOUND",
  "errorCode": "MANGO_NOT_FOUND",
  "message": "No active Mango owned by the authenticated creator matches `mangoId`. Missing, deleted, and foreign Mangoes intentionally share this response.",
  "result": "No active Mango owned by the authenticated creator matches `mangoId`. Missing, deleted, and foreign Mangoes intentionally share this response.",
  "success": false
}

{
  "code": 409,
  "type": "Conflict",
  "statusMessage": "CONFLICT",
  "errorCode": "IMPACTED_COUPONS_FOUND",
  "message": "One or more active creator coupons exceed the Mango price.",
  "result": "One or more active creator coupons exceed the Mango price.",
  "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
}

Update Mango

Authorization

Path Parameters

Header Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

429application/json

REMOTE_MEDIA_TOO_MANY_ITEMS

REMOTE_MEDIA_INVALID_URL

REMOTE_MEDIA_UNSUPPORTED_FILE_EXTENSION

MANGO_TITLE_REQUIRED

MANGO_TITLE_TOO_LONG

MANGO_TITLE_RESERVED

MANGO_DESCRIPTION_REQUIRED

MANGO_CURRENCY_INVALID

MANGO_RECURRING_TYPE_INVALID

MANGO_RECURRING_TYPE_REQUIRED

MANGO_CREATOR_NOT_ELIGIBLE

MANGO_START_IN_PAST

MANGO_ZERO_COST_PAID_CONFLICT

MANGO_PRICE_REQUIRED

MANGO_PRICE_OUT_OF_RANGE

MANGO_STRIKE_THROUGH_NOT_GREATER

MANGO_STRIKE_THROUGH_OUT_OF_RANGE

MANGO_STRIKE_THROUGH_WITHOUT_PRICE

MANGO_MULTI_CURRENCY_NOT_ALLOWED

MANGO_FREE_FIELD_FORBIDDEN

MANGO_SUBSCRIPTION_FIELD_FORBIDDEN

MANGO_ONETIME_FIELD_FORBIDDEN

MANGO_ADVANCED_PAYMENT_CONFLICT

MANGO_FLEXI_CONFIG_MISMATCH

MANGO_PART_PAYMENT_CONFIG_MISMATCH

MANGO_OPEN_ENDED_FIELD_FORBIDDEN

MANGO_FLEXI_FIELD_FORBIDDEN

MANGO_UPSELL_TIER_RESTRICTED

MANGO_UPSELL_PLATFORM_RESTRICTED

MANGO_FLEXI_PAY_NOT_ENTITLED

MANGO_PART_PAYMENT_NOT_ENTITLED

MANGO_CHECKOUT_TIMER_NOT_ENTITLED

MANGO_JUSPAY_NOT_ALLOWED

MANGO_NO_COST_EMI_NOT_ALLOWED

MANGO_NO_COST_EMI_JUSPAY_CONFLICT

MANGO_PG_OVERRIDE_NOT_ALLOWED

MANGO_VALIDITY_OUT_OF_RANGE

MANGO_SEATS_OUT_OF_RANGE

MANGO_SEATS_BELOW_ACTIVE_SUBSCRIBERS

MANGO_SEAT_LIMIT_TEXT_BLANK

MANGO_TRIAL_OUT_OF_RANGE

MANGO_MAX_BILLING_CYCLE_OUT_OF_RANGE

MANGO_FLEXI_INSTALLMENTS_INVALID

MANGO_FLEXI_INSTALLMENT_AMOUNT_TOO_LOW

MANGO_FLEXI_VALID_TILL_INVALID

MANGO_PART_PAYMENT_INSTALLMENTS_INVALID

MANGO_PART_PAYMENT_VALIDITY_INVALID

MANGO_PART_PAYMENT_MIN_INSTALLMENT_INVALID

MANGO_RENEW_CARD_INVALID

MANGO_CHECKOUT_TIMER_INVALID

MANGO_CUSTOM_FIELD_INVALID

MANGO_UPSELL_DETAIL_INVALID

MANGO_GST_NOT_CONFIGURED

MANGO_GST_INCLUDED_WITHOUT_GST

MANGO_OFFSHORE_GST_REQUIRED

MANGO_OFFSHORE_PINCODE_REQUIRED

MANGO_PINCODE_FIELD_REMOVED

MANGO_FREEBIE_NOT_OWNED

MANGO_ADDITIONAL_NOT_OWNED

MANGO_FUNNEL_NOT_ALLOWED

MANGO_FUNNEL_BRIDGING_NOT_ENABLED

MANGO_LINK_SELF_REFERENCE

MANGO_RECURRING_TYPE_IMMUTABLE

MANGO_TYPE_IMMUTABLE

MANGO_SUBSCRIPTION_PRICE_LOCKED

MANGO_START_DATE_IMMUTABLE

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`