POST /data/playlists/{playlist_id}/share/{token}/invite

Send the share URL by email to a list of recipients (raw emails and/or existing person ids).

Path parameters

  • playlist_id string(uuid) Required
  • token string Required
application/json

Body Required

  • emails array[string(email)]
  • person_ids array[string(uuid)]
  • message string

Responses

  • 200 application/json

    Invitations dispatched

    Hide response attribute Show response attribute object
    • sent array[string]
  • 400

    One of the supplied emails is invalid

POST /data/playlists/{playlist_id}/share/{token}/invite
curl \
 --request POST 'http://api.example.com/data/playlists/{playlist_id}/share/{token}/invite' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"emails":["hello@example.com"],"person_ids":["string"],"message":"string"}'
Request examples
{
  "emails": [
    "hello@example.com"
  ],
  "person_ids": [
    "string"
  ],
  "message": "string"
}
Response examples (200)
{
  "sent": [
    "string"
  ]
}