curl --request PATCH \
--url https://api.recoupable.dev/api/players/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"revision": 2,
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"spotifyUrl": "<string>",
"appleUrl": "<string>",
"artwork": "<string>",
"allowedOrigins": [
"<string>"
],
"enabled": false,
"audioUrl": "<string>"
}
'import requests
url = "https://api.recoupable.dev/api/players/{id}"
payload = {
"revision": 2,
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"spotifyUrl": "<string>",
"appleUrl": "<string>",
"artwork": "<string>",
"allowedOrigins": ["<string>"],
"enabled": False,
"audioUrl": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
revision: 2,
organizationId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
name: '<string>',
spotifyUrl: '<string>',
appleUrl: '<string>',
artwork: '<string>',
allowedOrigins: ['<string>'],
enabled: false,
audioUrl: '<string>'
})
};
fetch('https://api.recoupable.dev/api/players/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.recoupable.dev/api/players/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'revision' => 2,
'organizationId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'name' => '<string>',
'spotifyUrl' => '<string>',
'appleUrl' => '<string>',
'artwork' => '<string>',
'allowedOrigins' => [
'<string>'
],
'enabled' => false,
'audioUrl' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.recoupable.dev/api/players/{id}"
payload := strings.NewReader("{\n \"revision\": 2,\n \"organizationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"spotifyUrl\": \"<string>\",\n \"appleUrl\": \"<string>\",\n \"artwork\": \"<string>\",\n \"allowedOrigins\": [\n \"<string>\"\n ],\n \"enabled\": false,\n \"audioUrl\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.recoupable.dev/api/players/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"revision\": 2,\n \"organizationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"spotifyUrl\": \"<string>\",\n \"appleUrl\": \"<string>\",\n \"artwork\": \"<string>\",\n \"allowedOrigins\": [\n \"<string>\"\n ],\n \"enabled\": false,\n \"audioUrl\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.recoupable.dev/api/players/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"revision\": 2,\n \"organizationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"spotifyUrl\": \"<string>\",\n \"appleUrl\": \"<string>\",\n \"artwork\": \"<string>\",\n \"allowedOrigins\": [\n \"<string>\"\n ],\n \"enabled\": false,\n \"audioUrl\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"player": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"artist_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"spotify_url": "<string>",
"apple_url": "<string>",
"allowed_origins": [
"<string>"
],
"enabled": true,
"revision": 2,
"free_playback": "spotify",
"audio_url": "<string>",
"created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"artwork": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"listenUrl": "<string>",
"spotifyEmbedUrl": "<string>",
"appleEmbedUrl": "<string>"
}{
"error": "<string>",
"status": "<string>"
}{
"error": "<string>",
"status": "<string>"
}{
"error": "<string>",
"status": "<string>"
}{
"error": "<string>",
"status": "<string>"
}{
"error": "<string>",
"status": "<string>"
}{
"error": "<string>",
"status": "<string>"
}{
"error": "<string>",
"status": "<string>"
}{
"error": "<string>",
"status": "<string>"
}Update a release player
Edit branding, DSP destinations, embed origins, or enabled. Requires current revision; stale edits return 409. Artist/owner cannot change. Any update invalidates existing listening sessions. MCP: update_release_player.
curl --request PATCH \
--url https://api.recoupable.dev/api/players/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"revision": 2,
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"spotifyUrl": "<string>",
"appleUrl": "<string>",
"artwork": "<string>",
"allowedOrigins": [
"<string>"
],
"enabled": false,
"audioUrl": "<string>"
}
'import requests
url = "https://api.recoupable.dev/api/players/{id}"
payload = {
"revision": 2,
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"spotifyUrl": "<string>",
"appleUrl": "<string>",
"artwork": "<string>",
"allowedOrigins": ["<string>"],
"enabled": False,
"audioUrl": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
revision: 2,
organizationId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
name: '<string>',
spotifyUrl: '<string>',
appleUrl: '<string>',
artwork: '<string>',
allowedOrigins: ['<string>'],
enabled: false,
audioUrl: '<string>'
})
};
fetch('https://api.recoupable.dev/api/players/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.recoupable.dev/api/players/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'revision' => 2,
'organizationId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'name' => '<string>',
'spotifyUrl' => '<string>',
'appleUrl' => '<string>',
'artwork' => '<string>',
'allowedOrigins' => [
'<string>'
],
'enabled' => false,
'audioUrl' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.recoupable.dev/api/players/{id}"
payload := strings.NewReader("{\n \"revision\": 2,\n \"organizationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"spotifyUrl\": \"<string>\",\n \"appleUrl\": \"<string>\",\n \"artwork\": \"<string>\",\n \"allowedOrigins\": [\n \"<string>\"\n ],\n \"enabled\": false,\n \"audioUrl\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.recoupable.dev/api/players/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"revision\": 2,\n \"organizationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"spotifyUrl\": \"<string>\",\n \"appleUrl\": \"<string>\",\n \"artwork\": \"<string>\",\n \"allowedOrigins\": [\n \"<string>\"\n ],\n \"enabled\": false,\n \"audioUrl\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.recoupable.dev/api/players/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"revision\": 2,\n \"organizationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"spotifyUrl\": \"<string>\",\n \"appleUrl\": \"<string>\",\n \"artwork\": \"<string>\",\n \"allowedOrigins\": [\n \"<string>\"\n ],\n \"enabled\": false,\n \"audioUrl\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"player": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"artist_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"spotify_url": "<string>",
"apple_url": "<string>",
"allowed_origins": [
"<string>"
],
"enabled": true,
"revision": 2,
"free_playback": "spotify",
"audio_url": "<string>",
"created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"artwork": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"listenUrl": "<string>",
"spotifyEmbedUrl": "<string>",
"appleEmbedUrl": "<string>"
}{
"error": "<string>",
"status": "<string>"
}{
"error": "<string>",
"status": "<string>"
}{
"error": "<string>",
"status": "<string>"
}{
"error": "<string>",
"status": "<string>"
}{
"error": "<string>",
"status": "<string>"
}{
"error": "<string>",
"status": "<string>"
}{
"error": "<string>",
"status": "<string>"
}{
"error": "<string>",
"status": "<string>"
}Authorizations
Path Parameters
Body
x >= 1Authorized workspace; omit for the authenticated account. Never send account_id.
1 - 120Spotify track, album, or playlist URL. Share parameters are removed.
Apple Music song or album URL, optionally an album ?i= song selection.
Optional public HTTPS artwork.
Exact HTTPS origins authorized to embed this player; no path, query, credentials, or fragment.
10Publishing requires an active paid workspace. Disabled players are unavailable publicly.
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.
spotify, audio 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.
Show child attributes
Show child attributes
Stable provider route. This URL is returned even when that provider is unconfigured; inspect the corresponding destination in player before displaying it.
Stable provider route. This URL is returned even when that provider is unconfigured; inspect the corresponding destination in player before displaying it.
Was this page helpful?
