Dashboard
API Reference

Creates a collection content window

post
https://prod.suggestedtv.com/api/dashboard/v1/collection/content-window
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uuid

The ID of the collection

string

The current revision ID of the collection content

uuid

The ID of the collection this collection content belongs to

string
enum
Defaults to generic

The type of the collection. Defaults to generic.

Allowed:
uuid

The ID of the market in which this collection content window should be shown.

date-time

The date the collection content will be visible from. Defaults to the current time.

date-time

The date the collection content will be visible to.

string
required

The URL safe human readable identifier for the page

string
required

The name of the collection

string

The short description of the collection, no more than 250 characters

string

The description of the collection

image
object

The images to use with this collection. Master images are used to generate all other types and ratios where they are not specified. The following are the minimum resolutions for the best results:

  • Master 5040x2460
  • Thumb Master 1456x1398
  • Carousel Master 5040x2160
  • Hero Master 4096x2460
string

The number of the season.

uuid

The ID of the show the season belongs to.

uuid

The ID of the SEO metadata of the collection

children
array of objects
children
ageRatings
array of uuids

The IDs of the age ratings associated with the collection

ageRatings
categories
array of uuids

The IDs of the categories associated with the product.

categories
persons
array of objects
persons
boolean
Defaults to true

Whether the collection should appear in search results.

dynamic
personalized
object
string
enum

Which field to sort the collection by. If not set, the order will be the order supplied.

Allowed:
string
enum
Defaults to ascending

Whether to sort the collection ascending or descending.

Allowed:
number

The maximum number of items to show. If unset all items will be shown.

translations
object | null

A map of translations where the key is the ISO language code (e.g., 'en', 'fr') and the value is the localized content.

string

The ID of the VOD media which is the collection trailer.

Responses

Updated 11 days ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 days ago