Update a recording

Renames a recording and, when you send file, replaces its audio. name is required on every call, even when you are only changing something else, and the text-to-speech fields are replaced wholesale: tts_text, tts_ssml, tts_voice, tts_provider, and tts_editor_state are cleared whenever you omit them, and tts_speed and tts_instructions are always cleared. Sending new audio deletes the previous file first, converts the new one to WAV, and — unless you also send tts_ssml — transcribes it and stores the transcript as the recording's text. A recording a call flow owns cannot be edited here at all, and a recording a call flow uses cannot have its audio replaced; both are refused with 409. Requires an API key with the Admin role.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Id of the recording to update; must be a valid id and must belong to your account.

Body Params
string
required

New display name for the recording. Required on every call; control characters are stripped and the value is trimmed to 200 characters, and an empty result is rejected with 400.

string | null

New audio, either as a base64 string (a data: URL is accepted) or as { data, name, type }. Omit it to keep the current audio; the uploaded file is converted to WAV and the stored file name changes to match.

string | null

Spoken text for a generated recording. Ignored for audio uploads, where the automatic transcript is stored instead; cleared when omitted.

string | null

Speech markup for a generated recording. Sending it marks the recording as text-to-speech and skips transcription of any audio you send; cleared when omitted.

string | null

Name of the voice service the recording was generated with; cleared when omitted.

string | null

Name of the voice the recording was generated with; cleared when omitted.

tts_editor_state
object | null

Free-form editor state saved alongside a generated recording so it can be reopened and re-edited; cleared when omitted.

string

Short description for the recording, trimmed to 200 characters. When you omit it while sending new audio, the description is set from the transcript or the name instead.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json