Schedule a document version

Schedule a document version for publication. Browse request parameters, authentication requirements, response payloads, and working code samples in the Orbiq…

Schedule a document version for publication.

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Length1 <= length

versionId*string

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

scheduled_at*string

Local scheduled time interpreted in scheduled_timezone.

Length1 <= length

scheduled_timezone*string

IANA timezone used to interpret scheduled_at.

Length1 <= length

version_collection?ContentPublicationVersionCollection

Value in"documents" | "documents_translations"

make_active_on_publish?boolean

Defaulttrue

Response Body

`application/json`

curl -X PUT "https://example.com/api/v1/documents/string/versions/string/schedule" \  -H "Content-Type: application/json" \  -d '{    "scheduled_at": "2026-06-15T09:00:00",    "scheduled_timezone": "America/New_York",    "version_collection": "documents",    "make_active_on_publish": true  }'

{
  "success": true,
  "data": {
    "target_type": "document",
    "target_id": "string",
    "version_id": "string",
    "issues": [
      {
        "level": "error",
        "path": [
          "string"
        ],
        "message": "string"
      }
    ]
  }
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

How is this guide?

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

404application/json

502application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`