PATCH

Update Collection


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 a collection.

Authentication

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

Permissions
Manage Portfolio
Learn more about app permissions.
Endpoint
PATCH
https://www.wixapis.com/portfolio/v1/collections/{collection.id}

Path Params
collection.idstringRequired

Collection ID.

Body Params
collectionCollectionRequired

Collection to update.

Response Object
collectionCollection

Updated collection.

Update Collection
Request
cURL
curl -X PATCH \ 'https://www.wixapis.com/portfolio/v1/collections/123e4567-e89b-12d3-a456-426614174000' \ -H 'Authorization: <AUTH>' \ -H 'Content-Type: application/json' \ -d '{ "collection": { "id": "123e4567-e89b-12d3-a456-426614174000", "revision": 1, "title": "Updated Collection Title", "description": "This is an updated collection description.", "slug": "updated-collection-title", "coverImage": { "imageInfo": { "id": "8c074c67-2926-4518-92ef-c79d7810b3a4" } } "hidden": false, "sortOrder": 1.0 } }'
Response
JSON
{ "collection": { "id": "123e4567-e89b-12d3-a456-426614174000", "revision": 2, "title": "Updated Collection Title", "description": "This is an updated collection description.", "slug": "updated-collection-title", "coverImage": { "imageInfo": { "id": "8c074c67-2926-4518-92ef-c79d7810b3a4" } } "hidden": false, "sortOrder": 1.0, "createdDate": "2024-07-31T12:00:00Z", "updatedDate": "2024-07-31T12:30:00Z", "url": { "relative": "/collections/updated-collection-title", "url": "https://example.com/collections/updated-collection-title" } } }
Errors

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

Event TriggersThis method triggers the following events:
Did this help?