Updates a product

put

https://prod.suggestedtv.com/api/dashboard/v1/product/{id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uuid

required

The ID of the product to update

Body Params

uuid

The unique ID for the product

rev

string

The current revision ID of the product

reference

string

required

The unique URL safe identifier for the product

type

string

enum

The type of the product. Defaults to generic.

Allowed:

name

string

required

The name of the product

state

string

enum

Defaults to published

The enum representing whether the product may be visible or not, defaults to offline

Allowed:

shortDescription

string

The short description of the product, no greater than 250 characters

description

string

The description of the product

published

date-time

The date and time in the ISO 8601 format which the product was published.

duration

string

The duration of the product in the ISO 8601 format

released

date

The original release date of the product in the ISO 8601 format, this is not used by the system and considered only product metadata

episodeNumber

number

The number of the episode. Should only be defined when the product type is set to episode.

seasonId

uuid

The collection ID of the season which this episode belongs to. Should only be defined when the product type is set to episode.

showId

uuid

The collection ID of the show which this episode belongs to. Should only be defined when the product type is set to episode.

parentalAdvisory

string

The parental guidance specifications of the product

metadataId

uuid

The ID of the metadata of the product

image

object

The images to use with this product. 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

trailer

uuid

The ID of the VOD media which is the product trailer. Cannot be set for product type channel.

feature

uuid

The ID of the VOD media which is the product feature, or in the in the case of product type channel the ID of the live media.

indexable

boolean

Defaults to true

Whether the product should appear in search results.

ageRatings

array of uuids

The IDs of the age ratings associated with the product.

ageRatings

200Successful response

400Bad request

404The requested item could not be found