Update store configuration

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

Use this when a partner integration needs to enable or disable the storefront, update storefront copy, change cover or currency display settings, or configure the embeddable store widget.

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:

Store configuration is updated for the resolved community

Publishes update:store-config

Downstream store service processes the update

Widget configuration may be updated when widget is included

Rate limits:

Standard API rate limits apply

Constraints:

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

Data URL image values are rejected while uploads are incomplete

communityID is never accepted from request input

Upstream store-service failures return 502

Example — update:

{
  "isEnabled": true,
  "title": "Rewards Store",
  "description": "<p>Redeem community rewards.</p>",
  "currency": { "isEnabled": true, "name": "Coins" }
}

Related endpoints:

GET /stores — read store configuration

GET /categories — list store categories

GET /products — list active store products

What it is for: Update store configuration. Use this to read or update global store configuration for the community.
How to use it: Send a PUT request to /stores 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.
Availability note: this route is legacy or partner-service-backed. During a 2026-05-18 smoke test, the equivalent root path returned 404 on https://api.returning.ai; keep it marked non-primary until the gateway alias is confirmed.
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 store config success.", "data": { "_id": "507f1f77bcf86cd799439011", "communityID": "6502c9e514a3e564c5c09c0a", "isEnabled": true, "title": "Rewards Store", "description": "<p>Redeem community rewards.</p>", "currency": { "name": "Coins" }, "widget": { "isEnabled": true }, "updatedAt": "2026-04-28T00:00:00.000Z" } }

Request

Responses