Sanity Library Reference Docs
    Preparing search index...

    Interface EditVariantDefinitionActionBeta

    Edits an existing variant definition.

    interface EditVariantDefinitionAction {
        actionType: "sanity.action.variant.definition.edit";
        ifRevisionId?: string;
        patch: PatchOperations;
        variantId: string;
    }
    Index

    Properties

    actionType ifRevisionId? patch variantId

    Properties

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

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

    patch: PatchOperations

    Patch operations to apply.

    variantId: string

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

    Settings

    Member Visibility

    On This Page

    Properties