Skip to main content
PATCH
Update a collection

Authorizations

Authorization
string
header
required

Cactal API key. Create one in the dashboard or via POST /apiKeys. The plaintext key is shown once at creation.

Path Parameters

collectionId
string
required
Minimum string length: 1

Body

application/json
displayName
string
Required string length: 1 - 200
description
string | null
Maximum string length: 2000
slug
string

New slug for the collection — a rename. Omit to keep the current slug. Must be unique among the website’s active collections; when the website has a published version the rename is validated against the published site’s content queries.

Pattern: ^[a-z][a-z0-9-]{0,63}$

Response

The updated collection.

id
string
required

Unique collection id.

websiteId
string
required

Id of the owning website.

slug
string
required

URL-shaped identifier, unique among the website’s active collections. Lowercase letters, digits, and hyphens, starting with a letter; max 64 characters.

displayName
string
required

Human-readable name, 1–200 characters.

description
string | null
required

Optional description, up to 2,000 characters.

createdAt
string<date-time>
required

Creation timestamp.

updatedAt
string<date-time>
required

Last-modification timestamp.