Mark Item as Watched
All media items in Plex are marked as either being unwatched or watched. New items will automatically be marked as unwatched.
This API command will mark a specified media item as watched.
URL
GET http://{ip_address}:32400/:/scrobble?identifier=com.plexapp.plugins.library&key={key}&X-Plex-Token={plex_token}
Parameters
Name | Description |
---|---|
ip_address | The IP address of the Plex Media server. |
plex_token | The Plex token. |
key | The unique key for the media item to be marked as watched. Information about getting this key can be found below in the Media Key section. |
Return Status
HTTP Code | Description |
---|---|
200 | Success - The request was successful. |
401 | Unauthorized - The Plex token provided was not valid. |
Response
No response is returned. You will be able to see the clean bundles API command run from the Plex console.
Remarks
Media Key
The media key can be found using other API commands. For movies and videos, use the Get All Movies API command. From this API command get the integer value from the end of the key
attribute of the Video
element.
To mark entire TV shows, for all seasons and episodes, call the Get All TV Shows command and use the ratingKey
attribute value from the Directory
element.
For TV shows episodes, call the Get All TV Show Episodes command the use the integer value from the end of the key
attribute of the Video
element.
To mark a music track as played, call the Get All Tracks for a Music Album command and use the ratingKey
value from the Track
element.
Examples
curl -X GET http://{ip_address}:32400/:/scrobble?identifier=com.plexapp.plugins.library&key={key}&X-Plex-Token={plex_token}
import requests plex_url = http://{ip_address}:32400/:/scrobble?identifier=com.plexapp.plugins.library&key={key}&X-Plex-Token={plex_token} response = requests.get(plex_url) print(response.text)
$response = Invoke-RestMethod 'http://{ip_address}:32400/:/scrobble?identifier=com.plexapp.plugins.library&key={key}&X-Plex-Token={plex_token}' -Method 'GET' Write-Output $response