Update store category

Updates one store category for the API-key's community and returns the updated category.

Use this when a partner integration needs to rename a category, update category display assets, archive or unarchive it, change ordering, or adjust category-level access rules.

Authentication:

Bearer API key in Authorization header

API key must have the store permission

Community is resolved from the API key token — do not pass communityID

Returns 401 if the key is missing, invalid, or expired

Returns 403 if the key does not include the store permission

Side effects:

The category identified by categoryID is updated for the resolved community

Publishes update:category

Downstream store service processes the write

Rate limits:

Standard API rate limits apply

Constraints:

Body is a partial update; omit fields that should stay unchanged

categoryID must identify a category in the API key's community

displayOrder controls category sorting

categoryPermission entries must match the source store permission shape

Upstream store-service failures return 502

Example — update:

{
  "name": "VIP Rewards",
  "displayOrder": 10,
  "isArchived": false
}

Related endpoints:

GET /categories — list store categories

POST /categories — create a store category

GET /categories/{categoryID} — read a single store category

DELETE /categories/{categoryID} — delete a store category

What it is for: Update store category in the community store catalog. Use this to organize products into customer-facing store sections.
How to use it: Send a PUT request to /categories/{categoryID} with the request body, query parameters, or multipart fields shown below. Partner API key required when this surface is enabled for the community. Confirm gateway access before using in production.
Successful response: HTTP 200. The body follows the endpoint schema; many integration endpoints wrap the useful payload under data with status and message.
Common error states:

400 invalid request body, query, ObjectId, pagination, file format, or missing required field.

401 missing, invalid, expired, or insufficient API key/token.

403 key is valid but cannot access this community/channel/user/resource, where supported by the service.

404 target resource, route, or community-scoped record was not found.

409 duplicate or conflicting state for create/update operations, where applicable.

500 unexpected Returning.AI service error.

{ "meta": { "status": "success", "statusCode": 200 }, "message": "Update category success.", "data": { "_id": "507f1f77bcf86cd799439021", "communityID": "6502c9e514a3e564c5c09c0a", "name": "VIP Rewards", "coverImage": "https://example.com/category.png", "shouldShowCover": true, "isArchived": false, "viewType": "full", "displayOrder": 10, "defaultPurchaseStatusID": "650906d314a3e564c56f3450", "updatedAt": "2026-04-28T00:00:00.000Z" } }

Request

Responses