Sanity Library Reference Docs
    Preparing search index...

    Type Alias UnpublishAction

    Retract a published document. If there is no draft version then this is created from the published version. In either case the published version is deleted.

    type UnpublishAction = {
        actionType: "sanity.action.document.unpublish";
        draftId: string;
        publishedId: string;
    }
    Index

    Properties

    actionType draftId publishedId

    Properties

    actionType: "sanity.action.document.unpublish"
    draftId: string

    Draft document ID to replace the published document with

    publishedId: string

    Published document ID to delete

    Settings

    Member Visibility

    On This Page

    Properties