Skip to navigation

Replace organization Live Studio settings

Required scopes: live_studio.update.

Service-token organization UUID boundary applies; handles and foreign organization IDs return 404. Personal tokens and browser sessions are not accepted. Only organization_id, revision and normalized settings are returned; editor attribution and internal token principals are omitted. Requires a current strong Studio If-Match validator: missing 428, stale 412, malformed/weak/wildcard/list 422. Accepts settings only; revision is returned as metadata, not accepted in the body. Preserves existing domain validation and revision semantics. Complete settings are required except optional preset/transition defaults; invalid settings return 422 invalid_design. Identical PUTs still increment revision. Checks current explicit scope, organization status/verification and processing policy under the workspace lock. A processing restriction denies writes (403). Serializes with first saves, browser editor saves, credential changes and organization mutations. Concurrent writes with one validator produce one success and one 412. Persists before notifying organization Lives; changes styling without publishing presentation content or changing individual Live display/playback state. Transient notification failures do not turn a committed write into an error; reconnect/read loads the saved revision.

Response headers:

  • ETag (200): Strong validator covering the effective settings and revision. Separate from Live playback/display sequence validators. Use unchanged as If-Match on PUT.

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.

Path parameters

organization_idstringRequiredformat: "uuid"
Immutable organization UUID bound to the service token.

Headers

If-MatchstringRequiredformat: "^"studio-[a-f0-9]{64}"$"

Strong validator covering the effective settings and revision. Separate from Live playback/display sequence validators. Use unchanged as If-Match on PUT.

Request

This endpoint expects an object.
settingsobjectRequired

Full settings replacement using the existing version-1 Studio model. Only preset and transition may be omitted; they default to default and none. Every other field and all nested keys are required. Unknown fields are rejected at every level.

Response headers

ETagstringOptionalformat: "^"studio-[a-f0-9]{64}"$"

Strong validator covering the effective settings and revision. Separate from Live playback/display sequence validators. Use unchanged as If-Match on PUT.

X-Request-IdstringOptional

Response

Current organization Live Studio settings
organization_idstringformat: "uuid"
revisioninteger>=0

Settings revision independent of any Live sequence. Zero represents unsaved defaults; every accepted PUT increments the revision, even for identical settings.

settingsobject

Errors

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