Skip to main content
POST
/
playlists
Create a Playlist for current user
curl --request POST \
  --url https://open.beatpass.ca/api/v1/playlists \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "My playlist",
  "description": "<string>",
  "image": "<string>",
  "public": false,
  "collaborative": false
}
'
{
  "status": "success",
  "playlist": {
    "id": 123,
    "name": "Some Playlist",
    "public": true,
    "collaborative": false,
    "image": "https://example.com/image1.jpg",
    "description": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
name
string
Example:

"My playlist"

​
description
string | null

Short description (between 20 and 170 chracaters) for playlist

​
image
string | null

Image url for playlist

​
public
string | null
default:false

Whether this playlist will be set as public

​
collaborative
string | null
default:false

Whether this playlist will be set as collaborative

Response

On success, the response body contains the created playlist object in JSON format

​
status
string
Example:

"success"

​
playlist
object
Last modified on November 29, 2025