Update a dynamic playlist

patch https://api.jwplayer.com/v2/sites/{site_id}/playlists/{playlist_id}/dynamic_playlist/

Responses

Response body

object

schema

string

length between 8 and 8

Unique identifier for a resource

created

string

Date and time at which the resource was created

last_modified

string

Date and time at which the resource was most recently modified

type

string

Name of the type of resource.

relationships

object

Ancilliary resources associated to the primary resource being read

Has additional fields

metadata

object

title

string

Title of the playlist.
When using JW Player's HTML5 player, the playlist title is displayed in the overlay.
A maximum of 256 characters is permitted.

description

string

Description of the playlist
A maximum of 7500 characters is permitted.

author

string

Author of the playlist
A maximum of 256 characters is permitted.

link

string

URL to be associated with the playlist
A maximum of 2048 characters is permitted.

custom_params

object

User-generated key-value pairs

When defining custom_params, include all custom parameters that should be associated with the target resource.

When updating existing custom_params, include all custom_params keys with their updated values. Any custom_params key-value pair not included within the updated custom_params in the request body is deleted.

Has additional fields

tag_filter

object

Playlist tags to apply filtering logic from. The filter logic will change based the match value in the include and exclude sections (the match value can be one of any or all).

If the match mode is set to any, a video with any of the specified tags will be included or excluded from the playlist.
If the match mode is set to all a video must have all the specified tags to be included or excluded from the playlist.

custom_param_filter

object

Playlist custom parameters to apply filtering logic from. The filter logic will change based the match value in the include and exclude sections (the match value can be one of any or all).

If the match mode is set to any, a video with any of the specified custom paramaters will be included or excluded from the playlist. * If the match mode is set to all a video must have all the specified custom parameters to be included or excluded from the playlist.

media_filter

object

pinning

object

Playlist IDs to be pinned in the first and/or second slot of a playlist

Language

Credentials

Header

Request


xxxxxxxxxx
12
1
import requests
2
3
url = "https://api.jwplayer.com/v2/sites/site_id/playlists/playlist_id/dynamic_playlist/"
4
5
payload = { "metadata": { "media_filter": {
6
            "sort": "publish_start_date:dsc",
7
            "limit": 25
8
        } } }
9
headers = {
10
    "accept": "application/json",
11
    "content-type": "application/json"
12
}
13
14
response = requests.patch(url, json=payload, headers=headers)
15
16
print(response.text)

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Resource successfully updated

400Invalid JSON request body

404Resource with ID supplied does not exist in account and object namespace