Create

Create a new playlist. If logged in with a user, the playlist will be for that user

This action requires a request with an active account.

Tokens

This action requires the following tokens:

  • playlist-create

Arguments

Required arguments are marked in bold, and optional arguments are marked in italics.

Argument Type Default Description
title String   The title of the new playlist
description String   The description for the new playlist
externallink URL   A link where this playlist can be found (i.e. where the video is embedded)

Output

This action produces the following output on success:

An object containing the following fields:

Name Type Description
id Hash Playlist ID
user

User this playlist belongs to

The value of this field is an object containing the following fields:

Name Type Description
id Hash User ID
username String User name
account

Account this playlist belongs to

The value of this field is an object containing the following fields:

Name Type Description
id Hash Account ID
name String Account name
title String Title of the playlist
description String Description of the playlist
externallink String A link to an external page, such as a page containing more information about this playlist, or the page where this playlist is embedded
entries

Entries in this playlist. Each entry contains either an item or a livestream

The value of this field is an array containing zero or more elements, each one being an object containing the following fields:

Name Type Description
position Integer The sort order of this entry
skippable Boolean Is this playlist entry skippable
maxplaytime Duration The maximum play time for this playlist entry. Only useful for livestreams
item

The item of this entry, if any

The value of this field is an object containing the following fields:

Name Type Description
id Hash Item ID
title String Title of the item
description String Description of the item
type Label The type of this item; for available item types, refer to the documentation of the Item command
account

The account that created this item

The value of this field is an object containing the following fields:

Name Type Description
id Hash Account ID
name String Account name
datecreated DateTime When this item was created; for recordings of live-events, this is the date when the item finished recording
livestream

The livestream of this entry, if any

The value of this field is an object containing the following fields:

Name Type Description
id Hash Livestream ID
title String Title of the live stream
description String Description of the live stream
type Label The type of this livestream; for available livestream types, refer to the documentation of the Livestream command
deletedentity Boolean Whether the item or livestream for this entity is deleted

Errors

This action will always return one of the default status codes.