Sanity Library Reference Docs
    Preparing search index...

    Interface ScheduleReleaseActionBeta

    Schedules a release to be published at the given UTC time. Locks the version documents server-side until the release is unscheduled or published.

    interface ScheduleReleaseAction {
        dataset?: string;
        perspective?: ReleasePerspective | ClientPerspective;
        projectId?: string;
        publishAt: string;
        releaseId: string;
        resource?: DocumentResource;
        type: "release.schedule";
    }

    Hierarchy (View Summary)

    Index

    Properties

    dataset? perspective? projectId? publishAt releaseId resource? type

    Properties

    dataset?: string
    perspective?: ReleasePerspective | ClientPerspective
    projectId?: string
    publishAt: string
    releaseId: string
    resource?: DocumentResource

    Explicit resource to use. On an individual operation this overrides any default; on a SanityConfig it becomes the instance's default resource. Unlike projectId/dataset, this can also be a media library or canvas resource.

    type: "release.schedule"

    Settings

    Member Visibility

    On This Page

    Properties