API ReferenceCollections

Update

Update a collection's properties. Modifies the display name of an existing collection. Note that the readable ID cannot be changed after creation to maintain stable API endpoints and preserve any existing integrations or bookmarks.

Path parameters

readable_idstringRequired
The unique readable identifier of the collection to update

Headers

x-api-keystringRequired

Request

This endpoint expects an object.
namestring or nullOptional>=4 characters<=64 characters
Updated display name for the collection. Must be between 4 and 64 characters.

Response

Successful Response
namestring

Human-readable display name for the collection.

readable_idstring

URL-safe unique identifier used in API endpoints. This becomes non-optional once the collection is created.

idstringformat: "uuid"
Unique system identifier for the collection. This UUID is generated automatically and used for internal references.
created_atstringformat: "date-time"

Timestamp when the collection was created (ISO 8601 format).

modified_atstringformat: "date-time"

Timestamp when the collection was last modified (ISO 8601 format).

organization_idstringformat: "uuid"
Identifier of the organization that owns this collection. Collections are isolated per organization.
created_by_emailstring or nullformat: "email"
Email address of the user who created this collection.
modified_by_emailstring or nullformat: "email"
Email address of the user who last modified this collection.
statusenum or null

Current operational status of the collection:
• NEEDS_SOURCE: Collection exists but has no source connections configured yet
• ACTIVE: All source connections are healthy and data is being synced successfully
• PARTIAL_ERROR: Some source connections are failing but others are working
• ERROR: All source connections are failing or in error state

Allowed values:

Errors