Sanity Library Reference Docs
    Preparing search index...

    Interface BenchDeleteDefinitionArgs

    interface BenchDeleteDefinitionArgs {
        access?: WorkflowAccess;
        actor?: Actor;
        attributes?: UserAttributes;
        cascade?: boolean;
        definition: string;
        grants?: Grant[];
        grantsFromPath?: string;
        reason?: string;
        version?: number;
    }
    Index

    Properties

    access? actor? attributes? cascade? definition grants? grantsFromPath? reason? version?

    Properties

    access?: WorkflowAccess
    actor?: Actor
    attributes?: UserAttributes
    cascade?: boolean

    Abort every non-terminal instance pinned to the targeted versions before deleting. Instances are ONLY aborted — instance documents are never deleted; they stay in the lake as the audit record. Without this flag the delete refuses when such instances exist.

    definition: string

    The definition's name — delete addresses the workflow, not a doc id.

    grants?: Grant[]
    grantsFromPath?: string

    URL path for grant resolution — see StartInstanceArgs.grantsFromPath.

    reason?: string

    Free-text reason stamped on each cascade-abort history entry.

    version?: number

    Delete only this deployed version. Default: every deployed version.

    Settings

    Member Visibility

    On This Page

    Properties