PATCH

Update Category Visibility


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Updates category visibility.

Each time a category is updated, revision increments by 1. The current revision must be passed when updating a category. This ensures you're working with the latest category and prevents unintended overwrites.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Category write
Manage Stores - all permissions
Manage Products
Manage v3 catalog
Learn more about app permissions.
Endpoint
PATCH
https://www.wixapis.com/categories/v1/categories/visibility

Body Params
categoryIdstringRequiredformat GUID

Category ID.


visiblebooleanRequired

Whether the category is visible to site visitors in dynamic pages.

  • If a parent category's visibility is set to false, all the children categories' visibility will also be set to false.
  • Passing true will fail if the visibility of any parent categories is false.

treeReferenceTreeReferenceRequired

Category tree reference details.


revisionintegerRequiredformat int64

Latest revision of the category. To prevent conflicting changes, the current revision must be passed on update.


fieldsArray <string>maxItems 100

Fields to include in the response.

Response Object
categoryCategory

Updated category.

Update category visibility

Updates a category's visible field to false.

Request
cURL
Response
JSON
Errors
428Failed Precondition

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?