Update collection
With this endpoint, you can update details of a single collection, such as add or remove sub-collections, add validation rules for attributes, reorder collections, and more. Note:
1. This endpoint replaces the existing details.
2. To avoid impacting the entire data, for minor updates, use the Partially update collection endpoint instead - PATCH /collections/{id}.
Authorizations
S2S access token (JWT) from fabric Identity service (during Login)
Headers
A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.
Unique request ID
Path Parameters
System-generated 24-character collection ID
Body
Details to update collection
List of attributes assigned to the collection
Category IDs excluded in collection
Category IDs included in collection
true: Collection is active <br /> false: Collection is inactive
true: Collection name can be translated into different languages or localized for different regions. <br /> false: Collection name can't be localized. Note: Refer to localizedProperties to get relevant collection name based on locale.
Localized properties of collection
Non-localized collection name
Response
Collection details
Collection attributes
List of categories excluded
List of categories included
Immediate children of the specified collection
Time of category creation (UTC)
24-character system-generated collection ID
true: Collection is active <br /> false: Collection is inactive
true: Collection name is translated into different languages or localized for different regions <br /> false: Collection name isn't localized Note: Refer to localizedProperties to get relevant details based on locale
true: Collection is root category.<br /> false: Collection isn't a root category.
Localized details
Non-localized collection name
Attribute filters applied to the category
Time of last updated to category (UTC)
Email of user who last updated the category
Was this page helpful?