Update guest annotations for a preview file

PUT /shared/playlists/{token}/annotations
Jwt authorization

Update preview file annotations in the context of a shared playlist. Reuses the same additions/updates/deletions diff format as the manager-facing /actions/preview-files//update-annotations route, so concurrent edits stay safe via the Redis lock.

Path parameters

  • token string Required

    Share link token

application/json

Body Required

  • guest_id string(uuid) Required
  • preview_file_id string(uuid) Required
  • additions array[object]
  • updates array[object]
  • deletions array[string(uuid)]

Responses

  • 200 application/json

    Updated preview file with the new annotations
  • 400

    Missing required body fields

  • 403

    Annotations disabled for this share link, or the preview file is not part of the shared playlist

PUT /shared/playlists/{token}/annotations 
curl \
 --request PUT 'http://api.example.com/shared/playlists/{token}/annotations' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"guest_id":"string","preview_file_id":"string","additions":[{}],"updates":[{}],"deletions":["string"]}'
Request examples 
{
  "guest_id": "string",
  "preview_file_id": "string",
  "additions": [
    {}
  ],
  "updates": [
    {}
  ],
  "deletions": [
    "string"
  ]
}
Response examples (200) 
{}