Skip to main content
PATCH
Update a release player

Authorizations

x-api-key
string
header
required

Path Parameters

id
string<uuid>
required

Body

application/json
revision
integer
required
Required range: x >= 1
organizationId
string<uuid> | null

Authorized workspace; omit for the authenticated account. Never send account_id.

name
string
Required string length: 1 - 120
spotifyUrl
string<uri> | null

Spotify track, album, or playlist URL. Share parameters are removed.

appleUrl
string<uri> | null

Apple Music song or album URL, optionally an album ?i= song selection.

artwork
string<uri> | null

Optional public HTTPS artwork.

allowedOrigins
string<uri>[]

Exact HTTPS origins authorized to embed this player; no path, query, credentials, or fragment.

Maximum array length: 10
enabled
boolean
default:false

Publishing requires an active paid workspace. Disabled players are unavailable publicly.

freePlayback
enum<string>

Release-owner choice for verified Spotify Free accounts. spotify opens the configured Spotify release; audio plays a workspace-owned uploaded file. Premium continues using Spotify streaming.

Available options:
spotify,
audio
audioUrl
string<uri> | null

MP3 or WAV URL returned by POST /api/sites/assets for the same workspace. Requires an existing audio object; arbitrary or other-workspace URLs are rejected. Required when freePlayback is audio. Uploads currently have a 4 MB limit.

Response

PlayerResource fields returned by the release player service.

player
object
required
listenUrl
string<uri>
required
spotifyEmbedUrl
string<uri>
required

Stable provider route. This URL is returned even when that provider is unconfigured; inspect the corresponding destination in player before displaying it.

appleEmbedUrl
string<uri>
required

Stable provider route. This URL is returned even when that provider is unconfigured; inspect the corresponding destination in player before displaying it.