PATCH

Update Collection Properties

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 specified properties of a collection. To add products to a collection, call the Add Products to Collection endpoint.

Authentication

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

Permissions
Manage Stores - all permissions
Manage Products
Learn more about app permissions.
Endpoint
PATCH
https://www.wixapis.com/stores/v1/collections/{collection.id}
Path Params
collection.idstringRequired

Collection ID (generated automatically by the catalog).

Body Params
collectionCollectionRequired

Collection info.

Response Object
collectionCollection

Updated collection.

Update Collection Properties Example 1
Request
cURL
curl -X PATCH \
   'https://www.wixapis.com/stores/v1/collections/81093e7d-a251-4a22-a238-df3aa816f3dc' \
    --data-binary '{
                   	"collection": {
                   		"name": "Updated name"
                   	}
                   }' \
   -H 'Content-Type: application/json' \
   -H 'Authorization: <AUTH>'
Response
JSON
{
  "collection": {
    "id": "81093e7d-a251-4a22-a238-df3aa816f3dc",
    "name": "Updated name",
    "media": {
      "items": []
    }
  }
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?