Skip to navigation

Edit Live metadata

Required scopes: live.update.

Edits the name only. Omitted fields are preserved; unknown fields are rejected. No-op edits preserve ETag. Current scope, workspace and persisted sequence are rechecked under the workspace lock before an atomic save. Browser/command metadata edits also invalidate REST validators. Does not change display selection or playback state. 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.
namestringRequired1-128 characters

Nonempty UTF-8 name, at most 128 bytes.

Response headers

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

Response

Successful operation
Liveobject
OR
PersonalLiveobject

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