Update playlist

PUT /data/playlists/{instance_id}
Jwt authorization

Update a playlist with data provided in the request body. JSON format is expected. Requires project access. Vendor access is blocked.

Path parameters

  • instance_id string(uuid) Required
application/json

Body Required

  • name string
  • shots array[object]
    Hide shots attributes Show shots attributes object
    • entity_id string(uuid)
    • preview_file_id string(uuid)

Responses

  • 200 application/json

    Playlist updated successfully

    Hide response attributes Show response attributes object
    • id string(uuid)
    • name string
    • project_id string(uuid)
    • shots array[object]
    • created_at string(date-time)
    • updated_at string(date-time)
  • 400

    Invalid data format or validation error

PUT /data/playlists/{instance_id} 
curl \
 --request PUT 'http://api.example.com/data/playlists/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"name":"Updated Playlist Name","shots":[{"entity_id":"b24a6ea4-ce75-4665-a070-57453082c25","preview_file_id":"c24a6ea4-ce75-4665-a070-57453082c25"}]}'
Request examples 
{
  "name": "Updated Playlist Name",
  "shots": [
    {
      "entity_id": "b24a6ea4-ce75-4665-a070-57453082c25",
      "preview_file_id": "c24a6ea4-ce75-4665-a070-57453082c25"
    }
  ]
}
Response examples (200) 
{
  "id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "name": "Updated Playlist Name",
  "project_id": "b24a6ea4-ce75-4665-a070-57453082c25",
  "shots": [
    {}
  ],
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T11:00:00Z"
}