Skip to main content
PATCH
Rename a recording ID
Requires Editor, Admin, or Owner. The path id is the numeric record ID. The body recording_id is the new string identifier: 1–64 letters, digits, underscores, or hyphens. Matching references in workspace agent definitions are updated. A missing recording returns 404; a conflicting identifier returns 409. This differs from deletion, which takes the string recording ID in its path.

Authorizations

Authorization
string
header
required

Bandwidth Labs OAuth access token. Uses the user's selected workspace; the workspace header is not required. Do not also send an API key. Bearer-only operations may additionally require the Labs super_user role.

Headers

X-VOAI-ORGANIZATION-ID
string | null

Required with X-BW-LABS-AGENTS-API-KEY: the positive local workspace ID to access. The key owner must be a current member. Missing or invalid IDs return 400; non-member workspaces return 403. Not required for bearer authentication, which uses the user's selected workspace.

Path Parameters

id
integer
required

Body

application/json
recording_id
string
required
Required string length: 1 - 64
Pattern: ^[a-zA-Z0-9_-]+$

Response

Successful Response

created_at
string<date-time>
required
created_by
integer
required
id
integer
required
is_active
boolean
required
metadata
Metadata · object
required
organization_id
integer
required
recording_id
string
required
storage_backend
string
required
storage_key
string
required
transcript
string
required
tts_model
string | null
tts_provider
string | null
tts_voice_id
string | null
workflow_id
integer | null