Update information about a channel

Body Params

channel_key must be sent with each /channels/update request.

string
required

(Required) Key of the channel which should be configured or updated

string

Author of the channel.

string

Key-value pairs that are included in the playlist delivery

When creating these key-value pairs, be sure to adhere to the following guidance:

  • Key ({param}) can contain letters, numbers, and the punctuation characters: ., _ , -
  • Key cannot start with a number or punctuation character
  • Key cannot contain spaces
  • Do not use reserved names for custom parameters, reserved names include: feedid, kind, playlist
  • Do not use any existing non-custom parameter names, for example: title, description, author, etc.

Valid custom playlist parameters can be specified multiple times.

WARNING: Custom parameters that use a reserved name or an existing name are not guaranteed to be included in the output from the Delivery API.

If a parameter already exists in the database, it will be updated with the new value. If a parameter name starts with -, a matching parameter with the same name (but without the leading -) will be deleted from the database.

string

Description of the channel

string

Comma-separated list of name:value-formatted custom parameter(s) used by exclude_media_filtering_mode.

Parameter values are assumed not to contain commas.

string
enum

Excludes videos with custom parameters specified in exclude_media_filtering based on the options below:

  • all: (Default) Videos containing ALL the parameters specified in exclude_media_filtering are excluded from the results set.

  • any: Videos containing ANY of the parameters specified in exclude_media_filtering are excluded from the results set.

Works with all playlists (channels) except manual.

Allowed:
string

Comma-separated list of tag(s) used by exclude_tags_mode.

Tags are assumed not to contain commas.

string
enum

Excludes videos with tags specified in exclude_tags based on the options below:

  • all: (Default) Videos containing ALL the tags specified in exclude_tags are excluded from the results set.

  • any: Videos containing ANY of the tags specified in exclude_tags are excluded from the results set.

Works with all playlists (channels) except manual.

Allowed:
string

Comma-separated list of name:value-formatted custom parameter(s) used by media_filtering_mode.

Parameter values are assumed not to contain commas.

NOTE: The parameter inclusion only applies to the Delivery API. These rules will not apply to Management API.

string
enum

Includes videos with custom parameters specified in media_filtering based on the options below:

  • all: (Default) Videos containing ALL the parameters specified in media_filtering are included in the results set.

  • any: Videos containing ANY of the parameters specified in media_filtering are included in the results set.

Works with all playlists (channels) except manual.

Allowed:
string

Key of the playlist channel which will be pinned (promoted) into slot 1. Pinnable feed types include trending, dynamic and manual.

string

Key of the playlist channel which will be pinned (promoted) into slot 2. Pinnable feed types include trending, dynamic and manual.

string

Filters playlist based on the number of days or years passed since the publish date of a given media asset. Use the format of xD or xYR. For example, 9D will only serve media assets published less than 9 days ago OR 2YR will only serve media assets published less than 2 years ago.

string
enum

Videos sort order in a dynamic channel.

  • date-asc: (Default) By date ascending.
  • date-desc: By date descending.
  • duration-asc: By duration ascending.
  • duration-desc: By duration descending.
  • title-asc: By title ascending.
  • title-desc: By title descending.
  • views-asc: By views ascending. With the retirement of the views metric, this is based on plays within the last 90 days
  • views-desc: By views descending. With the retirement of the views metric, this is based on plays within the last 90 days
string

Comma-separated list of tag(s) used by tags_mode.

Tags are assumed not to contain commas.

NOTE: The tag inclusion only applies to the Delivery API. These rules will not apply to Management API.

string
enum

Includes videos with tags specified in tags based on the options below:

  • all: (Default) Videos containing ALL the tags specified in tags are included in the results set.

  • any: Videos containing ANY of the tags specified in tags are included in the results set.

Works with all playlists (channels) except manual.

Allowed:
string

Title of the channel

integer

(unsigned integer) Maximum number of videos to allow in a non-manual channel type

Here are the default values for each playlist type:

  • Dynamic playlist: 10
  • Feed (Recommendations) playlist: 25. This default value ensures that exactly three pages of videos are populated in the related overlay.
  • Search playlist: 10
  • Trending playlist: 10

WARNING: Maximum number of videos in the channel is not limited, but only the first 500 playlist entries will be returned by Delivery API.

Headers
string
enum
Defaults to application/xml

Generated from available response content types

Allowed:
Responses

Language
URL
LoadingLoading…
Response
Choose an example:
Response
© 2007- Longtail Ad Solutions, Inc.