CMS collections

Update a collection

Updates displayName (1–200 characters), description (up to 2,000 characters; pass null to clear), and/or slug (a rename). A slug change fails with a conflict when another active collection in the website already uses it, and when the website has a published version the rename is validated against the published site’s content queries and rejected when it would break them.

patch/cms/collections/{collectionId}

Request

  • Base URL: https://api.cactal.ai/v1
  • URL: https://api.cactal.ai/v1/cms/collections/{collectionId}
  • Auth: HTTP bearer

Path parameters

collectionIdstring required

Request body

displayNamestring
descriptionstring nullable
slugstring

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.

Response

The updated collection.

idstring required

Unique collection id.

websiteIdstring required

Id of the owning website.

slugstring required

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

displayNamestring required

Human-readable name, 1–200 characters.

descriptionstring nullable required

Optional description, up to 2,000 characters.

createdAtstring date-time required

Creation timestamp.

updatedAtstring date-time required

Last-modification timestamp.

Changes

No recorded changes to this operation across all 1 revision of this API.