CMS items

Publish, schedule, or unpublish an item

Use exactly one publication action: published: true publishes immediately and sets publishedAt to now; a future publishAt schedules a draft for automatic publication; published: false unpublishes an item or cancels its schedule. A published item must be unpublished before it can be scheduled because CMS items do not have revision snapshots. Published websites read only items with an actual publishedAt, so immediate and scheduled promotion become visible without a site republish. Repeating the same action is idempotent.

post/cms/items/{itemId}/set-published

Request

  • Base URL: https://api.cactal.ai/v1
  • URL: https://api.cactal.ai/v1/cms/items/{itemId}/set-published
  • Auth: HTTP bearer

Path parameters

itemIdstring required

Request body

publishedboolean

true publishes immediately; false unpublishes or cancels a schedule. Use publishAt instead to schedule publication.

publishAtunknown

Response

The item id plus its actual publishedAt and pending publishAt after the change.

idstring required

Id of the item.

publishedAtstring date-time nullable required

Actual publish timestamp after the change. Set when published immediately or by the scheduler; null for drafts and scheduled items.

publishAtstring date-time nullable required

Future publication time after the change; null for drafts and published items.

Changes

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