Skip to main content
PATCH
/
personas
/
background-sounds
/
{background_sound_id}
Update background sound
curl --request PATCH \
  --url https://api.coval.dev/v1/personas/background-sounds/{background_sound_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "display_name": "<string>",
  "default_volume": 1
}
'
import requests

url = "https://api.coval.dev/v1/personas/background-sounds/{background_sound_id}"

payload = {
"display_name": "<string>",
"default_volume": 1
}
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({display_name: '<string>', default_volume: 1})
};

fetch('https://api.coval.dev/v1/personas/background-sounds/{background_sound_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.coval.dev/v1/personas/background-sounds/{background_sound_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([
'display_name' => '<string>',
'default_volume' => 1
]),
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.coval.dev/v1/personas/background-sounds/{background_sound_id}"

payload := strings.NewReader("{\n \"display_name\": \"<string>\",\n \"default_volume\": 1\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.coval.dev/v1/personas/background-sounds/{background_sound_id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"display_name\": \"<string>\",\n \"default_volume\": 1\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.coval.dev/v1/personas/background-sounds/{background_sound_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 \"display_name\": \"<string>\",\n \"default_volume\": 1\n}"

response = http.request(request)
puts response.read_body
{
  "background_sound": {
    "id": "cafe",
    "value": "custom:3zfmuDbVQsi4GaseDtiVcS",
    "display_name": "Cafe",
    "default_volume": 0.3,
    "preview_url": "<string>",
    "preview_url_expires_at": "2023-11-07T05:31:56Z",
    "content_type": "audio/mpeg",
    "original_filename": "cafe-noise.mp3",
    "metadata": {},
    "created_at": "2023-11-07T05:31:56Z",
    "last_updated_at": "2023-11-07T05:31:56Z"
  }
}
{
"error": {
"code": "INVALID_ARGUMENT",
"message": "Invalid language_code 'en-ZZ'"
}
}
{
"error": {
"code": "UNAUTHENTICATED",
"message": "Missing or invalid API key"
}
}
{
"error": {
"code": "NOT_FOUND",
"message": "Persona abc123 not found"
}
}
{
"error": {
"code": "INTERNAL",
"message": "An unexpected error occurred"
}
}

Authorizations

X-API-Key
string
header
required

API key for authentication

Path Parameters

background_sound_id
string
required

Body

application/json

All fields are optional. Send status=archived to archive or status=active to restore.

display_name
string
Required string length: 1 - 200
default_volume
number<float>
Required range: x >= 0
status
enum<string>
Available options:
active,
archived

Response

Background sound updated successfully

background_sound
object
required