Skip to main content
PUT
Rename a background sound

Authorizations

Authorization
string
header
required

Headers

x-sub-organization-id
string

Optional sub organization ID. Must belong to your main organization API key.

Path Parameters

id
string
required

ID of the background sound to rename

Body

application/json

New display name for the background sound

name
string
required
Required string length: 1 - 100

Response

The renamed background sound

id
string
required

Unique identifier of the background sound

name
string
required

Display name of the background sound

Example:

"Cafe ambience"

organizationId
string | null

Organization that owns this background sound. Null for built-in presets available to all organizations.

source
enum<string>

How this background sound was created. USER = uploaded through the dashboard, API_KEY = uploaded through the public API, SYSTEM = built-in preset.

Available options:
USER,
API_KEY,
SYSTEM
createdBy
string | null

User ID of the uploader. Only populated when source is USER; null for API_KEY and SYSTEM uploads.

createdAt
string<date-time>

Timestamp when the background sound was created