PATCH /v1/collections/{collectionId}
Partially update a collection with a JSON request body.
PATCH /v1/collections/{collectionId} updates an existing collection.
Authentication
Send an organization API key in x-api-key or
Authorization: Bearer <key>.
Path Parameters
| Name | Type | Description |
|---|---|---|
collectionId | string (uuid) | UUID of the collection to update. |
Request Body
Send a JSON object containing at least one of the following fields.
| Name | Type | Description |
|---|---|---|
name | string | Collection name, from 1 to 100 characters. |
description | string or null | Description, up to 4,000 characters. Send null to clear it. |
teamIds | array of strings | Teams allowed to access the collection. |
isPubliclyVisible | boolean | Whether the collection is visible on the public website. |
Example
curl -X PATCH "https://api.blueputto.com/v1/collections/COLLECTION_ID" \
-H "x-api-key: YOUR_API_KEY" \
-H "content-type: application/json" \
-d '{"isPubliclyVisible":true}'Success Response
200 OK
{
"data": {}
}Error Responses
400 Bad Request401 Unauthorized404 Not Found429 Too Many Requests