Skip to main content

Update Recording Metadata

Endpoint: /recording/updateMetadata

This API allows you to update the metadata of a specific recording. It intelligently handles partial updates based on the provided fields:

  • To update a field, provide a new value.
  • To clear a text field (like Title), provide an empty string "".
  • To clear a specific map entry (like a subtitle), provide an empty object for that key.
  • If a field is omitted (i.e., nil), its existing value is kept.
FieldTypePositionRequiredDescription
record_idstringrootYesThe ID of the recording to update.
metadataRecordingMetadatarootNoThe metadata to update.

Example Request:

{
"record_id": "7f867cd7-7956-4a17-af46-6ddd4015a497-1761814595173",
"metadata": {
"title": "New Recording Title",
"description": "Intro session",
"subtitles": {
"en": {
"label": "English",
"url": "https://example.com/subtitle.vtt"
}
},
"extra_data": {
"any_key": "any_value",
"source": "cloud"
}
}
}

Response

FieldTypePositionDescription
statusbooleanrootThe status of the request
msgstringrootResponse message