---
title: "Update collection"
method: PUT
path: "/api/catalog/pvt/collection/{collectionId}"
tags: ["Collection"]
---

# Update collection

`PUT /api/catalog/pvt/collection/{collectionId}`

>⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with [collections configured through the Legacy CMS Portal](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L).

Updates a previously created Collection.

## Permissions

Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:

| **Product** | **Category** | **Resource** |
| --------------- | ----------------- | ----------------- |
| Catalog | Collection | **Write Collections** |

There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).

>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.

## Path parameters

- `collectionId` integer, required

## Headers

- `Content-Type` string, required
- `Accept` string, required

## Request body

- object
  - `Name` string, required — Collection name.
  - `Searchable` boolean, required — Defines if the collection is searchable or not.
  - `Highlight` boolean, required — Defines if the collection is highlighted or not.
  - `DateFrom` string, required — Initial value date for the collection.
  - `DateTo` string, required — Final value date for the collection.

## Response `200`

OK

- object
  - `Id` integer — Collection ID.
  - `Name` string — Collection name.
  - `Description` string, nullable — Collection description.
  - `Searchable` boolean — Defines if the collection is searchable or not.
  - `Highlight` boolean — Defines if the collection is highlighted or not.
  - `DateFrom` string — Initial value date for the collection.
  - `DateTo` string — Final value date for the collection.
  - `TotalProducts` integer — Total quantity of products in the collection.
  - `Type` string — [Type of the collection](https://help.vtex.com/en/tutorial/collection-types--5tKnhh8tMGIrVL7Fqirq7n).

---

[API](https://skmtc.net/vtex/apis/catalog-api.md) · [All operations](https://skmtc.net/vtex/apis/catalog-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vtex/catalog-api/revisions/d58c38c07169/schema)