POST/video/assets/bulk/tag

Add or remove tags from multiple video assets

Adds and removes tags on multiple video assets in one request. Supply asset_list, add_tags, remove_tags, and workspace_id to specify the assets, tag changes, and workspace. Pass an empty remove_tags array when you do not want to remove any tags.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

5 body fields

Bulk tag update request specifying the assets, tags to add or remove, and workspace.

add_tagsarray<string>required

List of tags to add to given assets.

asset_listarray<string>required

List of asset ids to update the tags for.

remove_tagsarray<string>required

List of tags to remove from given assets. Pass empty array if nothing is to be removed.

source_idstringdeprecatedoptional

Deprecated. Use workspace_id instead. Still accepted for backwards compatibility.

workspace_idstringrequired

Gumlet video workspace ID. Preferred over deprecated collection_id / source_id (same ID).

5 status codes
200Returns a success boolean indicating whether the tag operation was successful.
successbooleanrequired

Boolean flag indicating if operation was successful.

400Returned when the request is invalid.

One documented failure

  • assets_id_not_valid

    One or more asset IDs in asset_list are not valid.

errorobjectrequired
401Returned when the API key or bearer token is missing or invalid.

One documented failure

  • invalid_api_key

    API key supplied with request is invalid

errorobjectrequired
403Returned when the account has unpaid dues or the authenticated user lacks the required role permissions.

One documented failure

  • unauthorized

    You don't have access to this feature. Please contact your organization owner.

errorobjectrequired
500Returned when an internal server error occurs.

One documented failure

  • internal_server_error

    We have encountered some server error. We have been notified and will fix it soon.

errorobjectrequired

Error handling

A 400 is returned when the request is invalid; include asset_list, add_tags, remove_tags, and workspace_id in the body. A 401 is returned when the API key or bearer token is missing or invalid. A 403 is returned when the account has unpaid dues or the authenticated user lacks the required role permissions. A 500 indicates an internal server error.