Editing a Channel Set

You can change information about a channel set at any time.

Note: Channels and channel sets are supported in Player V3 only.
Note: For more information about Backlot REST API commands, see the Backlot API Reference.

To edit channel set information:

  1. To view the channel's information, use the GET /v2assets route with the asset ID of the channel set. The following example performs a get to obtain the current settings for channel set IwYTVxMjqLtYHmwqy.
    [GET]/v2/assets/IwYTVxMjqLtYHmwqy

    Backlot returns a response similar to the following.

    {
       "asset_type": "channel_set",
       "duration": 0,
       "name": "My Channel Set",
       "preview_image_url": null,
       "created_at": "2011-08-10T18:20:03+00:00",
       "embed_code": "IwYTVxMjqLtYHmwqy",
       "time_restrictions": null,
       "updated_at": "2011-08-10T18:20:04+00:00",
       "external_id": null,
       "hosted_at": null,
       "original_file_name": null,
       "description": null,
       "status": "live" 
    }
    Note:

    Try out the code samples using your account credentials in the Ooyala Scratchpad. For information about using the Scratchpad, see Practice Making Requests with the Scratchpad. To launch the scratchpad, go to Ooyala API Scratchpad.

  2. To change a channel's information, use PATCH with /v2/assets, the asset ID, and the updated properties in the request body. The following example changes the name, "hosted at" URL, and description.
    [PATCH]/v2/assets/dvNTVxMjrRktSlb5v{
       "name": "My Awesome Channel Set",
       "hosted_at": "http://www.mydomain.com",
       "description": "This is a set of channels." 
    }

    Backlot returns a response similar to the following.

    {
       "asset_type": "channel_set",
       "duration": 0,
       "name": "My Awesome Channel Set",
       "preview_image_url": null,
       "created_at": "2011-08-10T18:20:03+00:00",
       "embed_code": "IwYTVxMjqLtYHmwqy",
       "time_restrictions": null,
       "updated_at": "2011-08-10T18:20:04+00:00",
       "external_id": null,
       "hosted_at": "http://www.mydomain.com",
       "original_file_name": null,
       "description": "This is a set of channels.",
       "status": "live" 
    }
    Note:

    Try out the code samples using your account credentials in the Ooyala Scratchpad. For information about using the Scratchpad, see Practice Making Requests with the Scratchpad. To launch the scratchpad, go to Ooyala API Scratchpad.

The channel set is successfully edited.

Was this article helpful?