OCT-103 Gumlet outreach
POST/video/workspaces/{workspace_id}/folders/{folder_id}

Update a folder or move assets into it

Updates a folder's name or parent, or moves assets into it. Supply name to rename the folder, or asset_ids to move assets; use parent_id with asset_ids to specify a destination parent for those assets.

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

2 parameters · 3 body fields
workspace_idstringrequired

The ID of the video workspace containing the folder.

folder_idstringrequired

The ID of the folder to update.

Folder update details. Provide name to rename the folder, or asset_ids to move assets into it; parent_id can accompany asset_ids to specify their destination parent.

asset_idsarray<string>optional

Asset ids to move into this folder.

namestringrequired

New folder name.

parent_idstringoptional

New parent folder id. Send null to move the folder to the root level.

5 status codes
200Returns the updated folder object, or an object with a message and movedCount when assets are moved.
asset_countintegeroptional
Default:0
created_atstringoptional

ISO Timestamp

depthintegeroptional
Default:0
idstringoptional
namestringoptional
parent_idstringoptional
patharray<string>optional
path_namesarray<string>optional
subdirectory_countintegeroptional
Default:0
updated_atstringoptional

ISO Timestamp

video_source_idstringdeprecatedoptional

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

workspace_idstringoptional

Workspace ID

400Returned when the request is invalid.

One documented failure

  • folder_name_exists

    A folder with this name already exists in this location.

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 is unpaid or the authenticated user lacks sufficient role permissions.

One documented failure

  • unauthorized

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

errorobjectrequired
404Returned when the workspace or folder is not found.

One documented failure

  • folder_not_found

    Folder not found.

errorobjectrequired

Error handling

The workspace_id path parameter identifies the workspace, and the folder_id path parameter identifies the folder to update. Provide name to rename the folder, or asset_ids to move assets; parent_id can specify the destination parent for moved assets, and can be null when moving the folder to the root level. A 400 indicates a bad request, a 401 indicates missing or invalid authentication, a 403 indicates an unpaid account or insufficient role permissions, and a 404 indicates the requested resource was not found.