Skip to navigation

Replace queue ordering

Required scopes: live.update.

These resources represent the existing scripture stack published to the Live, not a separate draft playlist. Items are one canonical verse in one translation. IDs are scoped by Live, opaque, stable through reorder/metadata changes/restart, and change when a deleted item is recreated. Presentation mode returns 409 for queue reads/writes. Requires current If-Match; missing:428, stale:412, invalid:422. Current service scopes, organization ownership/status/processing and persisted sequence are rechecked before saving. Stopped Lives return 409. Changes persist before audience publication, switch/retain Reader mode, show remaining verses and resume a paused Live; deleting the last item clears the display. Accepts the complete current set of stable item IDs exactly once, in desired order. Unknown, duplicate, extra or omitted IDs return 422 invalid_queue_order. An identical order is a no-op preserving ETag and playback/visibility. Maximum 100 IDs; legacy larger stacks remain readable/removable until reduced below that limit. Returns the ordered snapshot. Also accepts finite personal bearer tokens for resources owned by the caller’s personal account. Personal tokens cannot operate organization Lives, use collaborators’/children’s authority, or publish presentations. Current personal token scopes and user permissions are rechecked after waits. Registered delegated OAuth access tokens are accepted within these personal boundaries; /me and account metadata additionally require identity.read.

Response headers:

  • ETag (200): Shared Live sequence validator. Any relevant metadata, display, playback or workspace change invalidates it.

Authentication

AuthorizationBearer

Organization-owned service token. Issue the initial token in organization credential settings. Scopes are documented per operation via x-required-scopes; they are not OAuth scopes.

OR
AuthorizationBearer

Personal bearer credential issued through existing account settings or browser-approved CLI flow. Must be active, finite, unexpired, unrevoked, within any rotation overlap, and bound to an active personal membership/user/account. Explicit scopes intersect current user permissions; empty existing personal scopes inherit current user authority. Not an OAuth grant or service token. Browser cookies are ignored.

OR
AuthorizationBearer

Registered public-client OAuth for personal-account resources only. Exact registered HTTPS or fixed-port literal loopback redirect; S256 required; explicit consent. No organization/presentation authority. identity.read is required for /me and account metadata. Scope intersection with current user authority; no empty-scope inheritance.

Path parameters

live_idstringRequired

Headers

If-MatchstringRequiredformat: "^"live-[0-9]+"$"

Shared Live sequence validator. Any relevant metadata, display, playback or workspace change invalidates it. Missing:428; stale:412; malformed, weak, wildcard or list:422.

Request

This endpoint expects an object.
item_idslist of stringsRequired
Complete permutation of the current item IDs. Missing, extra, foreign or duplicate IDs return 422. Empty is valid only for an empty queue.

Response headers

X-Request-IdstringOptional
ETagstringOptionalformat: "^"live-[0-9]+"$"
Shared Live sequence validator. Any relevant metadata, display, playback or workspace change invalidates it.

Response

Successful operation
LiveQueuePageobject
OR
PersonalLiveQueuePageobject

Personal-account Reader Live resource. Uses account_id instead of organization_id; only the personal account owner can access it with current personal token authority.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
503
Service Unavailable Error