Skip to main content
PATCH
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

collection_id
string<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.

Body

application/json
title
string | null

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).

Maximum string length: 1000
Example:

"Acme Corp - 2026"

description
string | null

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

Maximum string length: 10000
Example:

"Collection for 2026 Acme planning and execution notes."

updated_at
string<date-time> | null

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:

"2025-04-02T09:15:22Z"

Response

200 - application/json

OK

request_id
string
required

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

id
string<uuid>
required

UUID of the updated collection.

title
string
required

Current title of the collection after the update.

description
string | null
required

Optional description text currently stored on the collection.

created_at
string<date-time>
required

Creation timestamp for the collection in ISO 8601 format.

updated_at
string<date-time>
required

Last modification timestamp for the collection in ISO 8601 format.