466169815b78
Update an existing collection
Update an existing collection's name and lanes settings.
Only active collections that the user has update permissions for can be modified. Only the collection name and lanes setting can be updated through this endpoint. Other properties like scope and tiersEnabled cannot be changed after creation.
Note: Inactive (deactivated) collections will return 404 Not Found, even if you have UPDATE permission on them.
Request: Only name (required) and lanes (optional) fields can be updated. All other fields (scope, tiersEnabled, parentId) cannot be changed through this endpoint. See the PublicCollectionUpdatePayload schema for complete field definitions.
Validation Rules:
- Collection names must be unique within the user's scope (duplicate names will result in 409 Conflict)
- The collection must exist, be active (not deactivated), and be accessible to the user
- The user must have UPDATE permission on the collection
- The user must be the collection creator OR have been granted access to the collection
What happens when you update a collection:
- Collection Update: The collection's name and/or lanes setting are updated
- Audit Trail: The update is recorded in the audit log with:
- The user who updated the collection
- Timestamp of the operation
- Previous and new values for changed fields
- Reference to the public API endpoint used
- Audit comment: "Collection name and lanes updated via Public API"
Important Notes:
- Collection names must be unique within the user's scope - attempting to use a duplicate name will result in 409 Conflict
- Only name and lanes can be updated through this endpoint - all other fields (scope, type, tiersEnabled, parentId) are preserved from the existing collection
- The scope and tiersEnabled fields are immutable after creation
- Inactive (deactivated) collections cannot be updated and will return 404 Not Found
- All collection operations are audited for compliance and tracking purposes
Required Permissions: MANAGE_COLLECTION and UPDATE on the collection.
Path parameters
The unique identifier (ID) of the collection to update. This is the same identifier returned in the id field when retrieving collections via GET /public/v1/collections.
Request body
Response
200 OK - Collection updated successfully. The update has been audited with the comment 'Collection name and lanes updated via Public API'.