Sign in

v1

latestOpenAPI 3.1.02026-07-26183980.3 KB
external
external-v2

Update Collection

Update metadata for a collection by ID. Use this endpoint to rename a collection by setting title. This endpoint updates only provided fields (title, description) and leaves omitted fields unchanged. For read-only retrieval, use GET /v2/collections/{collection_id}.

patch/v2/collections/{collection_id}

Path parameters

collection_idstring uuid required

UUID of the collection to update. Use an ID returned by create/list/search. The caller must be able to edit this collection.

UUID of the collection to update. Use an ID returned by create/list/search. The caller must be able to edit this collection.

Request body

descriptionstring nullable

Optional descriptive text for collection scope or intent. Maximum: 10,000 characters (and no more than 10,000 UTF-8 bytes).

titlestring nullable

Human-readable collection title. Use a stable label suitable for navigation and exact title matching. Maximum: 1,000 characters (and no more than 1,000 UTF-8 bytes).

updated_atstring date-time nullable

Optional "last updated" timestamp for this write (ISO 8601). If provided, it must include a timezone offset and cannot be in the future. If omitted, the current server time is used.

Example request

{
  "description": "Collection for 2026 Acme planning and execution notes.",
  "title": "Acme Corp - 2026",
  "updated_at": "2025-04-02T09:15:22Z"
}

Response

OK

created_atstring date-time required

Creation timestamp for the collection in ISO 8601 format.

descriptionstring nullable required

Optional description text currently stored on the collection.

idstring uuid required

UUID of the updated collection.

request_idstring required

Identifier for this API request. Useful for tracing and support.

titlestring required

Current title of the collection after the update.

updated_atstring date-time required

Last modification timestamp for the collection in ISO 8601 format.

Example response

{
  "created_at": "2025-04-11T04:47:14.457Z",
  "description": "Collection for 2026 Acme planning and execution notes.",
  "id": "5e29c8a2-c73b-476b-9311-e2579712d4b1",
  "request_id": "api-request-036ed6c7-de00-459f-a89b-43d26aafe522",
  "title": "Acme Corp - 2026",
  "updated_at": "2025-04-12T10:15:00.000Z"
}