Rename a catalog, change its currency, or name its compare-at catalog

PATCH /catalogs/{catalogId}

Rename a catalog, change its currency, or name its compare-at catalog (compareAtCatalogId, null clears): the catalog whose price, when higher, every read serves beside this one's as compareAtCents, struck through.

It must be another active catalog in the same currency (409 CompareAtCatalogInvalid). The currency is fixed once it holds prices or another catalog derives from or compares against it (409 CatalogCurrencyFixed). taxInclusive changes whether its prices include tax, without restating them. Appends inventory.catalog-updated. Idempotent by content: a retry that changes nothing is acknowledged and appends nothing.

Access

Requires catalogs:write.

How scopes come from roles: Scopes and roles. Getting a token: Authentication and app tokens.

Retries

Idempotent by content: a retry that changes nothing is acknowledged and appends nothing.

Why every write carries a key: Idempotency and retries.

Facts appended

inventory.catalog-updated

What a fact is: Facts and the journal.

AI agent tool

Agents call this as catalog_update_catalog (Catalog: Update catalog), in the catalog toolset.

Connecting an agent: AI agents.

Example

Rename the wholesale catalog and hold its lines to a 25 % margin.

curl

curl -X PATCH 'https://inventory.getmanifold.io/catalogs/cat_019e394f-ed80-7da2-823a-3ff13eb84f30' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Trade",
  "minimumMarginBps": 2500
}'

JavaScript (fetch)

const response = await fetch("https://inventory.getmanifold.io/catalogs/cat_019e394f-ed80-7da2-823a-3ff13eb84f30", {
  method: "PATCH",
  headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "name": "Trade",
    "minimumMarginBps": 2500
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();

Request body · application/json

{
  "name": "Trade",
  "minimumMarginBps": 2500
}

Response · 200 · application/json

{
  "id": "cat_019e394f-ed80-7da2-823a-3ff13eb84f30",
  "name": "Trade",
  "currency": "AUD",
  "status": "active",
  "productCount": 2,
  "priceCount": 0,
  "pricing": {
    "_tag": "auto",
    "base": {
      "_tag": "catalog",
      "catalogId": "cat_019cadd3-8524-7934-9ee3-29b896f71f80"
    },
    "adjustment": {
      "_tag": "discount",
      "basisPoints": 3000
    },
    "rounding": [
      {
        "fromCents": 0,
        "stepCents": 100,
        "endingCents": 95
      }
    ]
  },
  "taxInclusive": "exclusive",
  "createdAt": "2026-05-18T04:20:00.000Z",
  "updatedAt": "2026-10-22T08:00:00.000Z",
  "minimumMarginBps": 2500
}

The panel writes this call in other languages. It does not send it: Manifold's APIs do not take calls from a web page on another site, so run the call from your own code or terminal. The whole API as OpenAPI: inventory-manager.openapi.json. Base URL https://inventory.getmanifold.io.

Errors

Every refusal is a status and a JSON body whose _tag names it. A refused call changes nothing.

`401`

Refusal	What it means	What to do
`Unauthorized` reason	The token is missing, expired or not one Manifold issued.	Get a fresh token and send the call again.
`TokenAlreadyUsed` tokenId	A single-use app token was already spent.	Mint a new token for this call.

`402`

Refusal	What it means	What to do
`SubscriptionRequired` status	The organization's subscription has lapsed, so writes are refused.	An owner settles billing. Reads still work meanwhile.

`403`

Refusal	What it means	What to do
`TenantRequired` userId	The token names no organization.	Choose the organization, then get a new token.
`ScopeRequired` required	The token's roles do not grant the scope this call needs.	Ask an owner or admin for a role that grants it.

`404`

Refusal	What it means	What to do
`CatalogNotFound` catalogId	No such record in this organization.	Check the id in the path or the body.

`409`

Refusal	What it means	What to do
`CatalogArchived` catalogId	The catalog is archived, and an archived catalog takes no changes.	Use an active catalog.
`CatalogNameConflict` name	Another catalog already has this name.	Choose another name.
`CompareAtCatalogInvalid` catalogId, reason	The compare-at catalog cannot be used. `reason` says why.	Choose another active catalog.
`CatalogCurrencyFixed` catalogId, currency, reason	The catalog's currency cannot change now. `reason` says why.	Make a new catalog in the other currency.
`MirroredFromSource` source	This area is fed by your source system until the organization goes live.	Make the change in the source system, or go live first.

`503`

Refusal	What it means	What to do
`RequestLogUnavailable` tokenId, reason	The service could not record the request, so it did nothing.	Send the same request again shortly.

How refusals work everywhere: Errors.