Skip to main content
id
string
required
status
enum<string>
required
Available options:
draft,
pending-review,
approved,
changes-requested,
merged,
discarded
authorId
string
required

Who acted: a member's user ID, or an API key's ID when it acted as itself

reviews
object[]
required
activityLog
object[]
required
dateCreated
string<date-time>
required
dateUpdated
string<date-time>
required
baseSdkConnection
object
required

The settings when the revision was created

proposedSdkConnection
object
required

The settings with this revision's changes applied

baseSdkWebhooks
object[]
required

The webhooks when the revision was created

proposedSdkWebhooks
object[]
required

The webhooks with this revision's changes applied

proposedChanges
object[]
required

The raw JSON Patch ops. Most callers can read the proposed* fields instead.

version
integer
title
string
author
object

Who created the revision, with an API key's name

contributors
string[]
revertedFrom
string
autoPublishOnApproval
boolean

Publish automatically the moment this revision is approved.

autoPublishEnabledBy
string

User or API key the deferred publish runs as, re-checked when it fires. A key that assumed a member's role is recorded as <keyId>:<memberId>.

autoPublishEnabledByUser
object

Who armed the deferred publish, with an API key's name

scheduledPublishAt
string<date-time>

When the deferred publish fires. Absent when the revision publishes on approval instead, or is not armed at all.

scheduledPublishLockEdits
boolean

Content edits to this revision are frozen until it fires.

scheduledPublishLockOthers
boolean

Other revisions of the same resource cannot publish until this one fires or is cancelled.

scheduledPublishBypassApproval
boolean

Armed by a caller who bypassed the approval requirement. Such a schedule must be cancelled and re-armed rather than edited.

scheduledPublishAttempts
integer

How many times the poller has tried to publish this revision.

scheduledPublishLastError
string

Why the most recent deferred-publish attempt failed.

scheduledPublishGaveUpAt
string<date-time>

When the poller stopped retrying. Giving up CLEARS the schedule and disarms auto-publish, so nothing fires again until the revision is re-armed. The draft is left open, with scheduledPublishLastError preserved for context.

resolution
object