Sanity Library Reference Docs
    Preparing search index...
    interface BenchDeleteDefinitionArgs {
        access?: WorkflowAccess;
        actor?: Actor;
        attributes?: UserAttributes;
        cascade?: boolean;
        definition: string;
        grants?: Grant[];
        grantsFromPath?: string;
        reason?: string;
        version?: number;
    }
    Index

    Properties

    Replaces the bench's access for this call. When supplied, individual access shortcuts are ignored.

    actor?: Actor

    Actor for this call. Omit to use the bench's actor. Changing only the actor retains the bench's default grants and attributes.

    attributes?: UserAttributes

    Attributes for this call. Omit to retain the bench's defaults; pass {} to clear them.

    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[]

    Grants for this call. Omit to retain the bench's default grants; pass [] to grant nothing.

    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.