Search.../
  1. Home
  2. Getting Started
  3. Overview
Generate a test token to explore our APIs

Update Collection Properties

Developer Preview

Updates specified properties of a collection. To add products to a collection, call the Add Products to Collection endpoint.

Authorization

This endpoint requires an authorization header - pass the access token from the OAuth installation flow.

Permissions

This endpoint requires the Manage Products permission scope.

PATCH

https://www.wixapis.com/stores/v1/collections/{collection.id}

Path Params

NAME
TYPE
DESCRIPTION
collection.id
Required

string

Collection ID (generated automatically by the catalog)

Body Params

NAME
TYPE
DESCRIPTION
collection
Required

object

Collection information.

Response Object

NAME
TYPE
DESCRIPTION
collection

object

Status/Error Codes

The response will include an HTTP status code.

Was this helpful?

Request

curl

Copy Code
1curl -X PATCH \
2 'https://www.wixapis.com/stores/v1/collections/81093e7d-a251-4a22-a238-df3aa816f3dc' \
3 --data-binary '{
4 "collection": {
5 "name": "Updated name"
6 }
7 }' \
8 -H 'Content-Type: application/json' \
9 -H 'Authorization: <AUTH>'

Response

json

1
2{"collection": {
3 "id": "81093e7d-a251-4a22-a238-df3aa816f3dc",
4 "name": "Updated name",
5 "media": {"items": []}
6}}