Sanity Library Reference Docs
    Preparing search index...

    Interface WorkflowRequestOptions

    interface WorkflowRequestOptions {
        body?: unknown;
        method?: "GET" | "POST";
        signal?: AbortSignal;
        tag?: string;
        url: string;
    }
    Index

    Properties

    body? method? signal? tag? url

    Properties

    Optionalbody

    body?: unknown

    JSON request body, sent with POST.

    method?: "GET" | "POST"

    HTTP method. Omitted means GET.

    signal?: AbortSignal
    tag?: string

    Optional ?tag= query for observability — supported by @sanity/client.

    url: string

    API-relative path, such as /users/me. @sanity/client prefixes it with the client's configured API base URL, so the host comes from client configuration.

    Settings

    Member Visibility

    On This Page

    Properties