Skip to navigation
Cloud Playout Channels

Update a channel

This endpoint updates a Cloud Playout channel’s name or the window it runs in. Provide only the fields you want to change; at least one is required.

How it works

  1. Make a PATCH request to this endpoint, replacing {channelId} with the UUID of the channel you want to update.

  2. Send any combination of name, startTime, and endTime.

  3. The response returns the channel with its updated details.

When a channel can be updated

A channel can only be updated while it is in draft or idle. Once the channel has been activated, it can no longer be updated; deactivate it first. The channel’s status cannot be changed through this endpoint: use the activate and deactivate endpoints instead.

A new startTime must be at least 3 minutes in the future, and endTime must stay after startTime. Changing the window does not move or remove the events already placed on the channel; events left outside the new window do not play.

Example

Before a channel goes on air, a scheduler pushes its endTime out by a day to extend a promotional run.

Authentication

AuthorizationBasic

FastPix APIs are secured with Basic Authentication. Use your Access Token ID as the username and Secret Key as the password in the Authorization header of each API request.

  • Username: Access Token ID
  • Password: Secret Key

Activate your FastPix account to generate your API credentials. See the guide here

Path parameters

channelIdstringRequiredformat: "uuid"
The unique identifier of the channel, returned by FastPix when the channel was created.

Request

This endpoint expects an object.
namestringOptional3-255 characters
A new name for the channel. It must be between 3 and 255 characters and can contain only alphanumeric characters, hyphens, underscores, and spaces.
startTimestringOptional

A new start time for the channel, in yyyy-MM-dd'T'HH:mm:ss format and interpreted as UTC. It must be at least 3 minutes in the future.

endTimestringOptional

A new end time for the channel, in yyyy-MM-dd'T'HH:mm:ss format and interpreted as UTC. It must be after the channel’s start time.

Response

Channel updated successfully
successbooleanOptional
Shows the request status. Returns true for success and false for failure.
dataobjectOptional
A Cloud Playout channel.