latestOpenAPI 3.0.02026-08-08270135.7 KB

c1404d1545ba

collections

Update collection

Update the metadata of an existing collection by its ID.

You can update the collection name or other editable fields.

**Use cases:**
- Renaming collections
- Managing collections in admin dashboards
- Bulk updating collection metadata
patch/api/v1/collections/{collectionId}

Path parameters

collectionIdstring required

Collection ID. Personal API keys may use 'private' for the key owner's virtual private collection. Workspace API keys cannot access private collections.

Request body

namestring required

Response

This response returns the details of the requested collection.

idstring required
isDefaultboolean
workspacestring required
creatorstring required
updaterstring
teamsstring[] required
createdstring date-time required
sortOrderstring
namestring required
updatedstring date-time required
isDeletedboolean
deletedAtnumber