Sanity Library Reference Docs
    Preparing search index...

    Interface UnpublishVariantActionBeta

    Unpublishes a variant version of a document.

    By default the published variant is removed and preserved as a draft variant. When a release id is given as the bundleId, the deletion is instead staged in that release, and takes effect when it is published.

    interface UnpublishVariantAction {
        actionType: "sanity.action.document.variant.unpublish";
        bundleId?: string;
        publishedId: string;
        variantId: string;
    }
    Index

    Properties

    actionType bundleId? publishedId variantId

    Properties

    actionType: "sanity.action.document.variant.unpublish"
    bundleId?: string

    The content release in which to stage the unpublish.

    By default, the currently published document is unpublished immediately.

    publishedId: string

    ID of the document group the variant belongs to. Must be a published document ID, without a drafts. or versions. prefix.

    variantId: string

    Name of the variant definition this document belongs to, as in _.variants.{variantName}. Must be a bare name, not a full document ID.

    Settings

    Member Visibility

    On This Page

    Properties