You are viewing the API documentation for BigBlueButton 3.x. The current version is BigBlueButton 4.x. Planning an upgrade? The migration guide lists every change your API calls need.
updateRecordings – Update Metadata
The updateRecordings endpoint allows you to add, modify, or remove metadata on one or more existing recordings. This is useful for labeling recordings after a meeting has ended — for example, adding a presenter name, a category, or a course identifier — without re-processing the recording itself.
Endpoint
GET/POST https://api-guide.bbbserver.com/bigbluebutton/api/updateRecordings?<parameter>&checksum=replace-with-checksum Both GET and POST methods are supported. When using POST, send parameters as application/x-www-form-urlencoded in the request body.
Required Parameters
| Parameter | Type | Description |
|---|---|---|
recordID | String | Required. A comma-separated list of recording IDs whose metadata should be updated. You can update multiple recordings in a single call by separating IDs with commas. |
Optional Parameters
| Parameter | Type | Description |
|---|---|---|
meta_<key> | String | One or more metadata key-value pairs. A non-empty value sets or updates the metadata entry. An empty value removes the metadata entry entirely. The key name follows the same format used in the create call. |
How Metadata Updates Work
Pass one or more meta_<key> parameters with a non-empty value to set or update the corresponding metadata entry.
Pass a meta_<key> parameter with an empty value to remove that metadata entry.
Any existing metadata entries that are not included in the call remain unchanged.
Example Request
Setting Metadata
GET https://api-guide.bbbserver.com/bigbluebutton/api/updateRecordings
?recordID=replace-with-recording-id
&meta_Presenter=Max+Mustermann
&meta_category=FINANCE
&checksum=replace-with-checksum Removing Metadata
GET https://api-guide.bbbserver.com/bigbluebutton/api/updateRecordings
?recordID=replace-with-recording-id
&meta_category=
&checksum=replace-with-checksum POST Request with cURL
curl --request POST \
--url "https://api-guide.bbbserver.com/bigbluebutton/api/updateRecordings" \
--header "Content-Type: application/x-www-form-urlencoded" \
--data "recordID=replace-with-recording-id&meta_Presenter=Max+Mustermann&meta_category=FINANCE&checksum=replace-with-checksum" Example Response
Success
<response>
<returncode>SUCCESS</returncode>
<updated>true</updated>
</response> Error — Missing recordID
<response>
<returncode>FAILED</returncode>
<messageKey>missingParamRecordID</messageKey>
<message>You must specify a recordID.</message>
</response> Error — Recording Not Found
<response>
<returncode>FAILED</returncode>
<messageKey>notFound</messageKey>
<message>We could not find recordings</message>
</response> Error Responses
| Message Key | Description |
|---|---|
checksumError | The checksum is invalid or does not match the expected value. |
missingParamRecordID | The required recordID parameter was not provided. |
notFound | No recording with the specified ID was found. The server only searches published and unpublished recordings — deleted recordings cannot be updated. |
Tips
Combine updateRecordings with the getRecordings endpoint to build a searchable recording archive. Add metadata like presenter name, department, or semester, then use the meta_ filter in getRecordings to retrieve recordings by those fields.
- You can update multiple recordings at once by passing a comma-separated list of IDs to the
recordIDparameter. - Existing metadata entries that are not mentioned in the call remain untouched — you do not need to resend all metadata every time.
- To remove a specific metadata entry, pass the key with an empty value. This is the only way to delete individual metadata fields.
- The metadata key format is identical to the one used in the
createcall:meta_yourKeyName=yourValue.
Frequently Asked Questions
recordID parameter. The same metadata changes will be applied to all specified recordings in a single call.updateRecordings endpoint only modifies the metadata entries you explicitly include in the request. All other existing metadata is preserved.meta_category= (with no value after the equals sign) will remove the category metadata entry from the recording.published and unpublished states. Deleted recordings cannot be found or updated. You will receive a notFound error if the recording has been deleted.