Type Alias PublishAction

PublishAction: {
    actionType: "sanity.action.document.publish";
    draftId: string;
    ifDraftRevisionId?: string;
    ifPublishedRevisionId?: string;
    publishedId: string;
}

Publishes a draft document. Replaces published version if it exists. Deletes the draft after publishing. Can check revision IDs for optimistic locking.

Type declaration

  • actionType: "sanity.action.document.publish"
  • draftId: string

    Draft document ID to publish

  • OptionalifDraftRevisionId?: string

    Draft revision ID to match (optional)

  • OptionalifPublishedRevisionId?: string

    Published revision ID to match (optional)

  • publishedId: string

    Published document ID to replace

Example

await client.action({
  actionType: 'sanity.action.document.publish',
  draftId: 'drafts.bike-123',
  publishedId: 'bike-123',
  ifDraftRevisionId: 'abc123',
  ifPublishedRevisionId: 'def456'
})

Settings

Member Visibility
MMNEPVFCICPMFPCPTTAAATR