Update Media Play Progress
This API command can be used to update the play progress of a media item.
URL
PUT http://[IP address]:32400/:/progress?key=[Media ID]&identifier=com.plexapp.plugins.library&time=[Time]&state=[State]&X-Plex-Token=[PlexToken]
Parameters
| Name | Description |
|---|---|
| IP address | The IP address of the Plex Media server. |
| PlexToken | The authentication Plex token. |
| Media ID | The key associated with the media item. |
| Time | The time, in milliseconds, used to se the media playback progress. |
| State | The playback state of the media item. |
Return Status
| HTTP Code | Description |
|---|---|
| 200 | Success - The request was successful. |
| 400 | Bad Request - A parameter was not specified, or was specified incorrectly. |
| 401 | Unauthorized - The Plex token provided was not valid. |
Response
No response is returned when a session is terminated. Check for a return status code of 200 to determine if the API call was successful.
Remarks
Progress time value
For the time parameter value, the value must be one millisecond above the minimum progress time. By default, the minimum progress time in Plex is 60000 milliseconds (1 minute), so the lowest value for the time parameter is 60001.
The minimum progress time value can be changed within the hidden settings with the minimumProgressTime setting.
State value
To mark the progress time for an item, set the state parameter value to "stopped".
Examples
Example 1
Set the progress time for media item with key 28625 to 90000 milliseconds (1 minute 90 seconds) on the Plex Media Server located at the IP address of 192.168.1.4:
PUT http://192.168.1.4:32400/:/progress?key=286254&identifier=com.plexapp.plugins.library&time=90000&state=played&X-Plex-Token=L6vkd7JtLHjsH5987vYY