Skip to main content
PATCH
Update background sound

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
acoustic_source_type
enum<string> | null

Acoustic rendering behavior for this sound.

  • ambient: mixed like room ambience.
  • point_source: rendered from a specific location when a situate_speaker preset is set; otherwise mixed like ambient.
Available options:
ambient,
point_source
status
enum<string>
Available options:
active,
archived

Response

Background sound updated successfully

background_sound
object
required