Update catalog

PUT/api/catalog-admin/current

Updates the active catalog configuration for the workspace.

Request Body

application/json

Request payload for Update catalog.

TypeScript Definitions

Use the request body type in TypeScript.

handle*string

Unique catalog handle used in public URLs.

Length5 <= length <= 50

note?|

Optional note shown on the catalog access screen.

status?|

Whether the catalog is enabled.

isPublic?|

Whether the catalog is publicly accessible without approval.

isDemo?|

Whether the catalog runs in demo mode.

restrictedToAllowedUsers?|

Whether only explicitly approved users can access the catalog.

allowAccessRequest?|

Whether users can request access from the catalog login screen.

Response Body

`application/json`

curl -X PUT "https://example.com/api/catalog-admin/current" \  -H "Content-Type: application/json" \  -d '{    "handle": "spring-sale"  }'

{  "success": true}

{  "_tag": "ApiBadRequestError",  "code": "PRICE_IMPORT_DUPLICATE_SKUS",  "message": "The request payload is invalid.",  "description": "Remove duplicate SKU rows before importing the file.",  "details": null}

{  "_tag": "Unauthorized"}

{  "_tag": "ApiForbiddenError",  "message": "You do not have permission to perform this action."}

{  "_tag": "ApiNotFoundError",  "message": "The requested resource was not found."}

{  "_tag": "ApiConflictError",  "message": "A resource with this handle already exists."}

{  "_tag": "ApiUnprocessableEntityError",  "message": "The order cannot be submitted without items."}

{  "_tag": "ServiceUnavailable"}

{  "_tag": "ApiTimeoutError",  "message": "The upstream operation timed out."}

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`