Skip to main content
POST
Publish, schedule, or unpublish an item

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

itemId
string
required
Minimum string length: 1

Body

application/json
published
boolean

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

publishAt
any

Future absolute timestamp for scheduling. Omit published; scheduled items remain hidden until the promotion job runs.

Response

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

id
string
required

Id of the item.

publishedAt
string<date-time> | null
required

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

publishAt
string<date-time> | null
required

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