Skip to main content
POST
/
playlists
/
{id}
/
invite
Invite a user to collaborate on a playlist
curl --request POST \
  --url https://open.beatpass.ca/api/v1/playlists/{id}/invite \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "user_id": 2
}'
{
  "status": "success",
  "message": "Invitation sent successfully"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
integer
required

Playlist ID

Example:

1

Body

application/json
​
user_id
integer

ID of user to invite

Example:

2

Response

Invitation sent successfully

​
status
string
Example:

"success"

​
message
string
Example:

"Invitation sent successfully"

Last modified on November 29, 2025