Sanity Library Reference Docs
    Preparing search index...

    Interface DeleteVariantDefinitionActionBeta

    Deletes a variant definition.

    Deletion fails if any document holds a strong reference to this variant.

    interface DeleteVariantDefinitionAction {
        actionType: "sanity.action.variant.definition.delete";
        ifRevisionId?: string;
        variantId: string;
    }
    Index

    Properties

    actionType ifRevisionId? variantId

    Properties

    actionType: "sanity.action.variant.definition.delete"
    ifRevisionId?: string

    When set, the action fails unless the current revision of the variant definition matches this value.

    variantId: string

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

    Settings

    Member Visibility

    On This Page

    Properties