OCT-103 Gumlet outreach
POST/video/playlist

Create a video playlist

Creates a playlist in a video workspace. Supply title and workspace_id; you can also provide a description for the playlist.

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

4 body fields

Playlist details. title and workspace_id are required.

collection_idstringdeprecatedoptional

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

descriptionstringoptional

Playlist description

titlestringrequired

Playlist title

workspace_idstringrequired

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

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

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

descriptionstringoptional

Playlist description

idstringrequired

Playlist ID

player_configobjectoptional

Player config for assets in the playlist

titlestringoptional

Playlist title

workspace_idstringoptional

Workspace ID

400Returned when the request is invalid.

One documented failure

  • title_duplication

    A playlist with this title already exist. All playlist titles under a workspace should be unique.

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
422Returned when request validation fails.

One documented failure

  • invalid_parameter

    body must have required property '<field>'

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. A 422 is returned when request validation fails. title and workspace_id are required; use workspace_id rather than the deprecated collection_id or source_id aliases.