> ## Documentation Index
> Fetch the complete documentation index at: https://weaverse.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Weaverse component configuration uses `settings`. `inspector` is deprecated; never generate it.
> Weaverse Hydrogen themes use React Router v7: import from `react-router`, never `react-router-dom` or `@remix-run/*`.
> Define component schemas with `createSchema()` from `@weaverse/hydrogen` (React Router themes) or `@weaverse/next` (Next.js themes).
> These docs cover @weaverse/hydrogen, @weaverse/react and @weaverse/core 5.x, and @weaverse/next 1.x. Do not use APIs from other major versions.
> For live project data (pages, theme settings, translations), use the Weaverse MCP server: https://docs.weaverse.io/developer-tools/weaverse-mcp

# Schedule a version for publication

> Schedules a saved page or theme version to go live at `publishAt`. For page drafts, `versionId` is the id returned by the draft save. The scheduler publishes the stored content when the time comes.

**Rules**

- `publishAt` must be in the future (400).
- One schedule per slot: a page can have at most one scheduled version, and a project at most one scheduled theme version. If the slot is taken, the response is 409 `CONFLICT` and nothing changes.
- A page draft can be scheduled only while it is still the page's draft head and was built on the current live page revision. A history version whose recorded page revision no longer matches live is 409 `STALE_PAGE`.
- At fire time the base is checked again. If live content moved after scheduling, the publication is cancelled instead of overwriting the newer edit (a draft returns to `ACTIVE`).

**Replacing a page schedule.** Set `replaceScheduledVersionId` to swap the page's current scheduled version for this one in a single transaction. The replaced version is closed (a draft returns to `ACTIVE`, a history version becomes `CANCELLED`). If it is no longer the page's scheduled version, the response is 409 `CONFLICT`. Two versions of different pages are 400 `INVALID_PARAMS`, and a version cannot replace itself. Retrying an identical replacement that already committed returns the scheduled row. For `type: "theme"` the field is refused with 400: no atomic theme replacement exists, so cancel the scheduled theme version first.

Manage the result with `PATCH /versions/{versionId}` (reschedule), `PUT /versions/{versionId}` (replace content), `DELETE /versions/{versionId}` (cancel) or `POST /versions/{versionId}/publish-now`.

Required scope: `content:publish`



## OpenAPI

````yaml https://studio.weaverse.io/api/v1/content/openapi.json post /versions/{versionId}/schedule
openapi: 3.1.0
info:
  title: Weaverse Content API
  version: 1.0.0
  description: >-
    Authenticated REST API for querying Weaverse-managed content (projects,
    pages, theme settings, languages) and for reading and writing per-locale
    translations.
servers:
  - url: https://studio.weaverse.io/api/v1/content
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Projects
    description: List, read, rename, create, copy and delete projects.
  - name: Pages
    description: List, read, create, update and delete the pages of a project.
  - name: Drafts and publishing
    description: >-
      Edit page drafts, then publish, schedule, restore and manage page
      versions.
  - name: Global sections
    description: Read, edit and publish sections shared across pages.
  - name: Page settings
    description: Read and edit page-level settings such as SEO metadata.
  - name: Assignments
    description: Map Shopify resources and routes to Weaverse pages and templates.
  - name: Theme settings
    description: Read and update a project's theme settings.
  - name: Languages and localization
    description: List project languages and manage locales, static text and glossary.
  - name: Translations
    description: >-
      Read and write per-locale translations, built for external translation
      agents.
  - name: Project structure
    description: Manage project variants and the project hierarchy.
  - name: Backups and portability
    description: Back up, restore, export and import project content.
  - name: Previews and hostnames
    description: Create preview links and manage the hostnames a project accepts.
  - name: Specification
    description: This OpenAPI document.
paths:
  /versions/{versionId}/schedule:
    summary: Schedule a version (content:publish)
    parameters:
      - name: versionId
        in: path
        required: true
        schema:
          type: string
    post:
      tags:
        - Drafts and publishing
      summary: Schedule a version for publication
      description: >-
        Schedules a saved page or theme version to go live at `publishAt`. For
        page drafts, `versionId` is the id returned by the draft save. The
        scheduler publishes the stored content when the time comes.


        **Rules**


        - `publishAt` must be in the future (400).

        - One schedule per slot: a page can have at most one scheduled version,
        and a project at most one scheduled theme version. If the slot is taken,
        the response is 409 `CONFLICT` and nothing changes.

        - A page draft can be scheduled only while it is still the page's draft
        head and was built on the current live page revision. A history version
        whose recorded page revision no longer matches live is 409 `STALE_PAGE`.

        - At fire time the base is checked again. If live content moved after
        scheduling, the publication is cancelled instead of overwriting the
        newer edit (a draft returns to `ACTIVE`).


        **Replacing a page schedule.** Set `replaceScheduledVersionId` to swap
        the page's current scheduled version for this one in a single
        transaction. The replaced version is closed (a draft returns to
        `ACTIVE`, a history version becomes `CANCELLED`). If it is no longer the
        page's scheduled version, the response is 409 `CONFLICT`. Two versions
        of different pages are 400 `INVALID_PARAMS`, and a version cannot
        replace itself. Retrying an identical replacement that already committed
        returns the scheduled row. For `type: "theme"` the field is refused with
        400: no atomic theme replacement exists, so cancel the scheduled theme
        version first.


        Manage the result with `PATCH /versions/{versionId}` (reschedule), `PUT
        /versions/{versionId}` (replace content), `DELETE /versions/{versionId}`
        (cancel) or `POST /versions/{versionId}/publish-now`.


        Required scope: `content:publish`
      operationId: scheduleVersion
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScheduleBody'
            example:
              projectId: clz7prj0a1b2c3d4e5f6g7h8
              type: page
              publishAt: '2026-12-01T09:00:00.000Z'
              replaceScheduledVersionId: clz8sch5d7f9h1j3l5n7p9r1
      responses:
        '200':
          description: Scheduled row
          content:
            application/json:
              schema:
                type: object
              example:
                object: version
                version:
                  id: clz9drf2h4j6l8n0p2r4t6v8
                  pageId: clz7pg9k2m4n6p8r0t2v4x6z
                  projectId: clz7prj0a1b2c3d4e5f6g7h8
                  userId: null
                  snapshot:
                    pageData:
                      id: clz7pg9k2m4n6p8r0t2v4x6z
                      name: Home
                      rootId: root-1
                      items:
                        - id: root-1
                          type: main
                          children:
                            - id: hero-1
                          data: {}
                        - id: hero-1
                          type: hero-image
                          data:
                            heading: Summer collection
                            height: large
                      expectedUpdatedAt: '2026-10-08T10:00:00.000Z'
                    pageAssignment:
                      type: INDEX
                      handle: ''
                      locale: ''
                  kind: DRAFT
                  draftBasePageUpdatedAt: '2026-10-08T10:00:00.000Z'
                  draftBaseProjectUpdatedAt: '2026-10-08T09:00:00.000Z'
                  publishedPageUpdatedAt: null
                  publishedProjectUpdatedAt: null
                  assignedType: INDEX
                  assignedHandle: ''
                  assignedLocale: ''
                  assignedMarket: null
                  assignmentDeferred: false
                  scheduleRevision: 1
                  createdAt: '2026-10-08T10:12:00.000Z'
                  publishAt: '2026-12-01T09:00:00.000Z'
                  publishedAt: null
                  status: SCHEDULED
                  page:
                    name: Home
        '400':
          description: >-
            publishAt must be in the future; replacement pair names versions of
            different pages (INVALID_PARAMS)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Foreign project or missing scope (INSUFFICIENT_SCOPE)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not found (never discloses other tenants)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: >-
            CONFLICT: the page/project already has a scheduled version, or the
            replacement lost its race. STALE_PAGE / STALE_PROJECT: the draft is
            no longer the head, or its page/project base moved. Nothing changed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                object: error
                code: CONFLICT
                message: Page already has a scheduled version
                status: 409
components:
  schemas:
    ScheduleBody:
      type: object
      required:
        - projectId
        - type
        - publishAt
      properties:
        projectId:
          type: string
        type:
          type: string
          enum:
            - page
            - theme
        publishAt:
          type: string
          format: date-time
        replaceScheduledVersionId:
          type: string
          description: >-
            Page versions only: a scheduled page version this schedule
            atomically replaces. Rejected with 400 for type=theme (no atomic
            theme replacement exists; cancel the scheduled theme version first).
    Error:
      type: object
      required:
        - object
        - code
        - message
        - status
      properties:
        object:
          type: string
          enum:
            - error
        code:
          type: string
          enum:
            - UNAUTHORIZED
            - FORBIDDEN
            - INSUFFICIENT_SCOPE
            - PROJECT_NOT_FOUND
            - PAGE_NOT_FOUND
            - STALE_PAGE
            - STALE_PROJECT
            - STALE_TRANSLATION
            - TRANSLATION_UNIT_NOT_FOUND
            - SERVICE_UNAVAILABLE
            - CONFLICT
            - PRECONDITION_REQUIRED
            - INVALID_PARAMS
            - INTERNAL_ERROR
        message:
          type: string
        status:
          type: integer
        details:
          description: >-
            Optional machine-readable context, for example the clashing handles
            of a 409 CONFLICT.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: WEAVERSE_API_KEY
      description: >-
        Bearer authentication: a shop API key (WEAVERSE_API_KEY), a scoped API
        key, a delegated MCP OAuth token, or (translation-unit routes only) a
        project-bound translation agent token. Scopes: content:read — Read
        projects, pages, theme settings, versions, drafts and translation units.
        content:write — Save drafts and make non-destructive edits (page items,
        metadata, SEO, assignments, languages, glossary). Never publishes or
        deletes. content:publish — Publish drafts, schedule/reschedule/cancel
        publications, restore versions, publish global sections. content:delete
        — Delete pages, global sections, languages, static keys, override
        reverts; required with project:manage for project deletion.
        project:manage — Create/copy/delete projects, settings, variants,
        hierarchy, backups, restore-as-new, previews, hostname policy.
        translations:read — Read translation units only (no general content
        access). translations:write — Apply translation units only; never
        mutates page content. A legacy unscoped API key keeps
        read/write/translation baseline access and every pre-scope endpoint, but
        never gains publish/delete/project-manage implicitly.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.