AimableDocs
DocsAPI ReferenceRelease Notes
PATCH/v1/collections/{collection_id}

Update Collection Metadata

Update collection metadata (name, description). Requires collections.manage permission.

Path Parameters

NameTypeRequiredDescription
collection_idstring (uuid)Required

Headers

NameTypeRequiredDescription
X-API-KeystringOptional

Request Body

application/jsonRequired
nameobject
descriptionobject
Authentication
X-API-Key: ak.<key_id>.<secret>Authentication & errors →

Request

curl -X PATCH '/api/v1/collections/{collection_id}' \
  -H 'X-API-Key: ak.<key_id>.<secret>' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": {},
  "description": {}
}'

Response

200

No response body documented

Error Responses