Manipulating Playlists

/api/playlists/create

Creates a playlist.

Param	Type	Required	Description
user_id	Int	yes	The user to create this playlist for
data	Array	yes	The metadata for the playlist
data.name	String	yes	The title of the playlist
data.description	String	no	The description of the playlist
data.folder_id	Int	no	The folder id of the folder you want the playlist inside of

Returns the created ClientPlaylist.

/api/playlists/copy

Creates a copy of a playlist.

Param	Type	Required	Description
playlist_id	Int	yes	The playlist id you want to copy
name	String	yes	The name of the new playlist
user_id	Int	no	The user id of the copy’s owner, otherwise, the copy is created on the original author

Returns the copied ClientPlaylist.

/api/playlists/edit

Updates the metadata of a playlist.

Param	Type	Required	Description
playlist_id	Int	yes	The playlist to edit
data	Array	yes	The metadata for the playlist
data.name	String	yes	The title of the playlist
data.description	String	no	The description of the playlist
data.folder_id	Int	no	The folder id of the folder you want the playlist inside of
data.includeNested	Int	no	(0 or 1) Whether to included nested tracks in the playlist

Returns the created ClientPlaylist.

/api/playlists/delete

Deletes a playlist.

Param	Type	Required	Description
playlist_id	Int	yes	The playlist id you want to delete

Returns {success: 1}.

/api/playlists/createFolder

Creates a playlist folder.

Param	Type	Required	Description
user_id	Int	yes	The user to create this folder for
data	Array	yes	The metadata for the folder
data.name	String	yes	The title of the folder
data.description	String	no	The description of the folder
data.folder_id	Int	no	The folder id of the parent folder you want the folder inside of

Returns a ClientPlaylistFolder:

{
	name: 'My Folder Name',
	description: 'This is a folder, not a playlist.',
	folder: 3444
}

/api/playlists/editFolder

Updates the metadata of a playlist folder.

Param	Type	Required	Description
folder_id	Int	yes	The folder to edit
data	Array	yes	The metadata for the folder
data.name	String	yes	The title of the folder
data.description	String	no	The description of the folder
data.folder_id	Int	no	The folder id of the parent folder you want the folder inside of

Returns a ClientPlaylistFolder.

/api/playlists/deleteFolder

Deletes a playlist folder.

Param	Type	Required	Description
folder_id	Int	yes	The folder id you want to delete

Returns {success: 1}.