/channels/update

Configure or update the properties of a channel.

Parameters

channel_key : string

Key of the channel which should be configured or updated.

title (optional) : string

Title of the channel.

description (optional) : string

Description of the channel.

link (optional) : string

User defined URL.

author (optional) : string

Author of the channel.

tags (optional) : string

List of tag(s) used by tags_mode (Include). Multiple tags should be comma separated.

tags_mode (optional) : string

Includes only videos with the tags specified in tags based on the options below. Works with all channels/playlists except Manual.

all

Videos tagged with ALL of the specified tags in ‘tags’ are included in the results set.

any

Videos tagged with ANY of the specified tags in ‘tags’ are included in the results set.

Default is all.

exclude_tags (optional) : string

List of tag(s) used by ‘exclude_tags_mode’ (Exclude). Multiple tags should be comma separated.

Note

Exlude tags feature only applies to Delivery API. These rules will not apply to Management API.

exclude_tags_mode (optional) : string

Excludes videos with tags specified in ‘exclude_tags’ based on the options below. Works with all channels/playlists except Manual.

all

Videos tagged with ALL the specified tags in ‘exclude_tags’ are excluded from the results set.

any

Videos tagged with ANY of the specified tags in ‘exclude_tags’ are excluded from the results set.

Default is all.

sort_order (optional) : string

Specifies sorting order of the videos in a dynamic channel:

date-asc

By date ascending.

date-desc

By date descending.

title-asc

By title ascending.

title-desc

By title descending.

duration-asc

By duration ascending.

duration-desc

By duration descending.

views-asc

By views ascending. With the retirement of the views metric, this is based on plays within the last 30 days

views-desc

By views descending. With the retirement of the views metric, this is based on plays within the last 30 days

Default is date-desc.

videos_max (optional) : unsigned integer

Maximum number of videos to allow in a non-manual channel type. Default is 10 for dynamic, trending, and search type playlists. Similar feed type playlists have a default of 25 in order to populate exactly three pages of the related overlay.

Warning

Maximum number of videos in the channel is not limited, but only the first 100 playlist entries will be returned by Delivery API when the playlist is embedded or published as an RSS feed.

custom.param (optional) : string

User defined parameter. param part of the request parameters (after the ‘.’ separator) specifies name of the parameter. Parameter name should adhere to the following naming rules:

  • name can contain letters, numbers and the punctuation characters ‘.’, ‘_’, ‘-‘
  • name cannot start with a number or punctuation character
  • name 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.

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.

Valid custom channel parameters can be updated multiple times.

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.

pin_slot_1 (optional) : string

Key of the playlist channel which will be pinned (promoted) into slot 1. Pinnable feed types include trending, dynamic and manual. The target feed in question (channel key) must be of type Feed or Search.

pin_slot_2 (optional) : string

Key of the playlist channel which will be pinned (promoted) into slot 2. Pinnable feed types include trending, dynamic and manual. The target feed in question (channel key) must be of type Feed or Search.

Example response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>ok</status>
</response>

Response parameters

/response/status : string

Call execution status. Set to ok if call executed successfully.