OCT-103 Gumlet outreach
POST/video/playlist/{playlist_id}

Update a video playlist

Updates a playlist's title, description, channel visibility, display position, or player configuration. Include only the settings you want to change; channel_visibility defaults to false when supplied without a value.

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

1 parameter · 5 body fields
playlist_idstringrequired

The ID of the playlist to update.

Playlist settings to update; all body fields are optional.

channel_visibilitybooleanoptional

If true then playlist will be visible on channel page.

Default:false
descriptionstringoptional

Playlist description

player_configobjectoptional

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

positionintegeroptional

Playlists have order in which they will be shown on the channel page.

titlestringoptional

Playlist title

4 status codes
200Returns the updated playlist, including its ID, title, description, workspace ID, and player configuration.
collection_idstringdeprecatedoptional

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

descriptionstringoptional

Updated playlist description

idstringrequired

Playlist ID

player_configobjectoptional
titlestringoptional

Updated playlist title

workspace_idstringoptional

Workspace ID

400Returned when the request is invalid.

One documented failure

  • incorrect_playlist_id

    No playlist with provided id exists.

errorobjectrequired
401Returned when the request has a missing or invalid API key or bearer token.

One documented failure

  • invalid_api_key

    API key supplied with request is invalid

errorobjectrequired
403Returned when the account is unpaid or the authenticated user has insufficient role permissions.

One documented failure

  • unauthorized

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

errorobjectrequired

Error handling

A 400 is returned for a bad request. A 401 is returned when the request has a missing or invalid API key or bearer token. A 403 is returned for an unpaid account or insufficient role permissions. The playlist_id path parameter identifies the playlist to update.