Sign in

v50

latestOpenAPI 3.0.3raw.githubusercontent.com2025-01-2810050281.4 KB
Playlists

Create Playlist

Creates a new playlist.

A maximum of 1000 videos can be added to a playlist (both Manual and Smart). There is no limit to the number of playlists that can be created. The videos that are initially loaded into a playlist in the player is determined by the type of playlist.

post/v1/accounts/{{account_id}}/playlists

Path parameters

account_idstring required

Video Cloud account ID.

Headers

Content-Typestring required

Content-Type: application/json

Authorizationstring required

Authorization: Bearer {access_token} - see Getting Access Tokens

Request body

descriptionstring

playlist description

favoriteboolean

whether playlist is in favorites list

namestring

the playlist name

reference_idstring

the playlist reference id (must be unique within the account)

searchstring

search string to retrieve the videos (smart playlists only)

search_syntax'v1' | 'v2'

the search syntax used for the search string; see Managing Playlists

type'EXPLICIT' | 'ACTIVATED_OLDEST_TO_NEWEST' | 'ACTIVATED_NEWEST_TO_OLDEST' | 'ALPHABETICAL' | 'PLAYS_TOTAL' | 'PLAYS_TRAILING_WEEK' | 'START_DATE_OLDEST_TO_NEWEST' | 'START_DATE_NEWEST_TO_OLDEST'

the playlist type: EXPLICIT or smart playlist type

video_idsstring[]

array of video ids (EXPLICIT playlists only) - maximum length: 1000

Example request

{
  "description": "My new sea playlist",
  "name": "Sea Videos",
  "type": "ACTIVATED_NEWEST_TO_OLDEST",
  "limit": 20,
  "search": "tags:birds"
}

Response

Playlist created

account_idstring

Video Cloud account id

created_atstring date-time

date/time created

descriptionstring

playlist description

favoriteboolean

whether playlist is in favorites list

idstring

the playlist id

namestring

the playlist name

reference_idstring

the playlist reference id (must be unique within the account)

searchstring

search string to retrieve the videos (smart playlists only)

state'READY' | 'UPDATING'

Applies to EXPLICIT (manual) playlists only; UPDATING means the list is updating its video members and READY means that all videos have been added

type'EXPLICIT' | 'ACTIVATED_OLDEST_TO_NEWEST' | 'ACTIVATED_NEWEST_TO_OLDEST' | 'ALPHABETICAL' | 'PLAYS_TOTAL' | 'PLAYS_TRAILING_WEEK' | 'START_DATE_OLDEST_TO_NEWEST' | 'START_DATE_NEWEST_TO_OLDEST'

the playlist type: EXPLICIT or smart playlist type

updated_atstring date-time

date/time last modified

video_idsstring[]

array of video ids (EXPLICIT playlists only)

Example response

{
  "id": "5716873476001",
  "account_id": "57838016001",
  "created_at": "2018-01-23T12:55:29.674Z",
  "description": "My new sea playlist",
  "favorite": false,
  "name": "Sea Videos",
  "reference_id": null,
  "type": "ACTIVATED_NEWEST_TO_OLDEST",
  "updated_at": "2018-01-23T12:55:29.677Z",
  "limit": 20,
  "search": "+tags:\"birds\""
}