Playlist

Set dynamic playlist tags

Modify a dynamic playlist by changing the tags it uses to grab content, then instruct all players connected to the playlist to check in.

PUT

/api/v1/playlist/tags

curl --request PUT \
  --url 'https://voyager.korbyt.com/api/v1/playlist/tags?name=sample_playlist&id=1' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "operator": "In",
    "relationToNext": "And",
    "tags": [
      "tag1",
      "tag2",
      "tag3"
    ]
  },
  {
    "operator": "Contains",
    "relationToNext": "Or",
    "tags": [
      "tag4",
      "tag5"
    ]
  },
  {
    "operator": "In",
    "tags": [
      "tag6"
    ]
  }
]
'

The body of the request should be a JSON array of rule objects. Each rule should have the following attributes:

tags: An array of tag strings
operator: A string defining what operator to use when comparing content against the tag list. The options for this field are:
- 'Contains' - This operator will match content tags that are identical to or contain any of the rule tags. (For example "RedCar" is a match for tags containing "Car, Truck").
- 'In' - This operator will match content tags exactly. (For example, "PickupTruck" is NOT a match for tags in "Car, Truck").
relationToNext: When multiple rules are defined, this attribute determines how this rule will be combined with the one after it. The valid options are 'And' and 'Or'. If an invalid relation or no relation is supplied, it will default to 'And'. The order that tag rules rules will be evaluated in is the same as the SQL default (ANDs will be evaluated first, followed by ORs).

An example request body has been provided.

Authorizations

Authorizationstringheaderrequired

Access token from POST /api/v1/auth/login

Query Parameters

namestringquery

Playlist name (case insensitive)

Example: sample_playlist

idintegerquery

Playlist id

Example: 1

Body

itemsobject[]

Show child attributes

Response

Success. Response body is not documented in the source collection.

Still need help? Share an idea