Sanity Library Reference Docs
    Preparing search index...

    Type Alias DeleteAction

    Deletes the published version of a document and optionally some (likely all known) draft versions. If any draft version exists that is not specified for deletion this is an error. If the purge flag is set then the document history is also deleted.

    type DeleteAction = {
        actionType: "sanity.action.document.delete";
        publishedId: string;
        includeDrafts: string[];
        purge?: boolean;
    }
    Index

    Properties

    actionType publishedId includeDrafts purge?

    Properties

    actionType: "sanity.action.document.delete"
    publishedId: string

    Published document ID to delete

    includeDrafts: string[]

    Draft document ID to delete

    purge?: boolean

    Delete document history

    Settings

    Member Visibility

    On This Page

    Properties