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

Update a video workspace

Updates settings for an existing video workspace. Supply only the workspace properties you want to change, such as name, player_config, or the configuration for its storage type. A 200 response returns the updated workspace.

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

1 parameter · 20 body fields
workspace_idstringrequired

The Gumlet workspace ID, available in the dashboard or from the workspace list.

Workspace properties to update. The body fields are optional; provide the storage configuration fields required when updating a storage type.

awsobjectoptional

This is a required field if workspace type is aws.

azureobjectoptional

This is a required field if workspace type is azure.

backblazeobjectoptional

This is a required field if workspace type is backblaze.

channel_settingsobjectoptional

Configurations to set various channel settings.

cloudflareobjectoptional

This is a required field if workspace type is cloudflare.

cloudinaryobjectoptional

This is a required field if workspace type is cloudinary.

default_profile_idstringoptional

Gumlet provides the functionality of creating multiple video assets using the same set of parameters.

dostorageobjectoptional

This is a required field if workspace type is dostorage.

gcsobjectoptional

This is a required field if workspace type is gcs.

insight_property_idstringoptional

The five to ten character unique identifier of the Gumlet Insight Property available on the dashboard.

linodeobjectoptional

This is a required field if workspace type is linode.

namestringoptional

video workspace name

player_configobjectoptional

Configure player settings for this playlist, it overrides the setting set on workspace.

proxyobjectoptional

This is a required field if workspace type is proxy.

temp_cnamearray<string>optional

cname for channel

typestringoptional

Video workspaces are top-level entities in Gumlet. You can use them to organize videos for different teams/departments or use cases.

Allowed:proxydirect-uploadwebfolderawsgcsdostoragewasabicloudinaryazurelinodebackblazecloudflare
video_protectionobjectoptional

Gumlet provides multiple options for securing your video playback.

wasabiobjectoptional

This is a required field if workspace type is wasabi.

webfolderobjectoptional

This is a required field if workspace type is webfolder.

zoomobjectoptional

This is a required field if workspace type is zoom.

4 status codes
200Returns the updated workspace object, including its ID, name, type, player configuration, folders, and channel settings.
awsobjectoptional
channel_settingsobjectrequired
created_atstringrequired
default_profile_idstringoptional
embed_detailsobjectoptional
foldersarray<string>required
idstringrequired

Workspace ID

insight_property_idstringoptional
insights_enabledbooleanrequired

Whether Gumlet video analytics is enabled for this workspace.

namestringrequired

Workspace name

player_configobjectrequired
typestringrequired

Workspace type

updated_atstringrequired
video_protectionobjectoptional
400Returned when the request is invalid.

One documented failure

  • collection_not_found

    Could not find any video workspace with specified workspace_id.

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

Error handling

The workspace_id path parameter must identify the workspace to update. A 400 indicates a bad request, a 401 indicates missing or invalid authentication, and a 403 indicates an unpaid account or insufficient role permissions. If you include a storage configuration object, provide the fields required for its storage type; channel_settings.privacy_type must be one of "public", "private", or "password-protected".