v1

latestOpenAPI 3.1.02026-07-24251250397.8 KB

playlists

Create a recommendations playlist

post/v2/sites/{site_id}/playlists/recommendations_playlist/

Path parameters

site_idstring required

Unique identifier for a resource

Example:Ny05CEfj

Unique alphanumeric ID of the site

Request body

Example request

{
  "metadata": {
    "custom_params": {
      "param1": "value1"
    },
    "custom_param_filter": {
      "include": {
        "values": {
          "param1": "value1"
        }
      },
      "exclude": {
        "values": {
          "param1": "value1"
        }
      }
    },
    "pinning": {
      "slot1": "Ny05CEfj",
      "slot2": "Ny05CEfj"
    }
  }
}

Response

Resource successfully created

schemastring

idstring

Unique identifier for a resource

createdstring

Date and time at which the resource was created

last_modifiedstring

Date and time at which the resource was most recently modified

typestring

Name of the type of resource.

relationshipsobject

Ancilliary resources associated to the primary resource being read

Example response

{
  "schema": "https://schema.jwplayer.com/types/thumbnail.json",
  "id": "Ny05CEfj",
  "created": "2019-09-25T15:29:11.042095+00:00",
  "last_modified": "2019-09-25T15:29:11.042095+00:00",
  "metadata": {
    "custom_params": {
      "param1": "value1"
    },
    "custom_param_filter": {
      "include": {
        "values": {
          "param1": "value1"
        }
      },
      "exclude": {
        "values": {
          "param1": "value1"
        }
      }
    },
    "pinning": {
      "slot1": "Ny05CEfj",
      "slot2": "Ny05CEfj"
    }
  }
}