> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://fastpix.com/docs/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://fastpix.com/docs/_mcp/server.

# Add an event to a schedule channel

POST https://api.fastpix.com/v1/cloud-playout/channels/{id}/schedule-event
Content-Type: application/json

This endpoint schedules content on a Cloud Playout schedule channel. Unlike a loop channel, which repeats its programs, a schedule channel plays what you place on its timeline at the time you place it. The `id` in the path is the channel's ID.

#### How it works

1. Make a POST request to this endpoint with an `event` object describing what to play and when it starts.

2. What else you send depends on the `type`:

   * `vod` plays one media item. Send its `referenceId` and leave `endTime` and `name` out, because the event ends when the media does.
   * `playlist` plays every item in a playlist back to back. Send the playlist's `referenceId` and leave `endTime` and `name` out.
   * `live` reserves a slot for the channel's live input. Send `endTime` and a `name`, and leave `referenceId` out. The slot must be at least 5 minutes long.

3. The response returns the events that were created. A `playlist` becomes one event per item in it, laid end to end from `startTime`.

The event must sit inside the channel's own start and end times, and it cannot overlap an event that is already scheduled. Media used by a `vod` event must have reached the `ready` status. On a channel that is on air, an event cannot be added if it would start or end in the next few minutes.

#### Example

A news channel schedules a recorded bulletin at 18:00, then reserves a live slot from 19:00 to 20:00 for a press conference.


Reference: https://fastpix.com/docs/cloud-playout-api/schedule-channel/add-event-to-cloud-playout-schedule-channel

## Authentication

- `Authorization` header (basic auth, required) — 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

## Request

### Path parameters

- `id` (string, required) — The unique identifier of the schedule channel the event is added to.

### Body (application/json)

This endpoint expects a CloudPlayoutScheduleEventRequest.

- `event` (CloudPlayoutScheduleEventCreate, required)

## Response

### 201

Event added to the schedule channel successfully

- `success` (boolean, optional) — Shows the request status. Returns true for success and false for failure.
- `data` (list of CloudPlayoutScheduleEvent, optional) — The events on the channel, in the order they play.

## Types

### CloudPlayoutScheduleEventCreate

- `type` (enum, required) — What the event plays. `vod` plays a single media item, `playlist` plays every item in a playlist back to back, and `live` reserves a slot for the channel's live input.
  - Allowed values: `vod`, `playlist`, `live`
- `startTime` (string, required) — When the event starts, in `yyyy-MM-dd'T'HH:mm:ss` format and interpreted as UTC. It must fall inside the channel's own start and end times.
- `referenceId` (string, optional) — The unique identifier of the media for a `vod` event, or of the playlist for a `playlist` event. Required for both, and must be left out for a `live` event.
- `endTime` (string, optional) — When the event ends, in `yyyy-MM-dd'T'HH:mm:ss` format and interpreted as UTC. Required for a `live` event, and must be left out for `vod` and `playlist` events, which end when their content does.
- `name` (string, optional) — A name for a `live` event. It must be between 3 and 255 characters and can contain only alphanumeric characters, hyphens, underscores, and spaces. Required for a `live` event, and must be left out for `vod` and `playlist` events, which take their name from the media.

### CloudPlayoutScheduleEvent

An event on a Cloud Playout schedule channel.

- `id` (string, optional) — The unique identifier FastPix assigns to the event. Use this identifier when you update or remove it.
- `channelId` (string, optional) — The unique identifier of the channel the event is scheduled on.
- `type` (enum, optional) — What the event plays. A `playlist` you scheduled is returned as one `vod` event per item in it.
  - Allowed values: `vod`, `live`
- `referenceId` (string, optional, nullable) — The unique identifier of the media the event plays. Not returned for a `live` event.
- `name` (string, optional) — The name of the event. For a `vod` event this is the media's title, and for a `live` event it is the name you gave the event.
- `startTime` (datetime, optional) — When the event starts, defined as a localDateTime (UTC Time).
- `endTime` (datetime, optional) — When the event ends, defined as a localDateTime (UTC Time).
- `duration` (string, optional) — How long the event runs, formatted as `HH:MM:SS`.
- `sourceResolution` (string, optional) — The resolution the event is played out at.
- `thumbnail` (string, optional, nullable) — A URL to the event's thumbnail image.
- `bumper` (CloudPlayoutScheduleEventBumper, optional) — The bumpers attached to the event. Each key is present only when a bumper of that kind is attached.
- `segments` (list of CloudPlayoutSegment, optional) — The segments marked on the event, in the order they occur.
- `createdAt` (datetime, optional) — Time the event was created, defined as a localDateTime (UTC Time).
- `updatedAt` (datetime, optional) — Time the event was last updated, defined as a localDateTime (UTC Time).

### CloudPlayoutScheduleEventBumper

The bumpers attached to the event. Each key is present only when a bumper of that kind is attached.

- `preroll` (CloudPlayoutScheduleEventRollResponse, optional)
- `postroll` (CloudPlayoutScheduleEventRollResponse, optional)

### CloudPlayoutSegment

A time window marked on an item, which can carry bumpers around it.

- `id` (string, optional) — The unique identifier FastPix assigns to the segment.
- `segmentMediaId` (string, optional) — The unique identifier of the media the segment is marked on.
- `startTime` (integer, optional) — The point in the media where the segment begins, in seconds from the start of the media.
- `duration` (integer, optional) — The length of the segment in seconds.
- `bumper` (CloudPlayoutSegmentBumper, optional) — The bumpers attached to this segment. Each key is present only when a bumper of that kind has been added.
- `thumbnail` (string, optional, nullable) — A URL to the segment's thumbnail image.
- `status` (string, optional, nullable) — The current state of the segment.

### CloudPlayoutScheduleEventRollResponse

- `id` (string, optional) — The unique identifier of the bumper.
- `duration` (integer, optional) — The duration of the bumper in seconds.

### CloudPlayoutSegmentBumper

The bumpers attached to this segment. Each key is present only when a bumper of that kind has been added.

- `preroll` (CloudPlayoutSegmentBumper, optional) — The bumpers attached to this segment. Each key is present only when a bumper of that kind has been added.
- `postroll` (CloudPlayoutSegmentBumper, optional) — The bumpers attached to this segment. Each key is present only when a bumper of that kind has been added.

## Examples

**Request**

```json
{
  "event": {
    "type": "vod",
    "startTime": "2026-09-02T18:00:00",
    "referenceId": "8c2c4ef1-1c2a-4a49-9c5b-8f9c0a7c3d21"
  }
}
```

**Response**

```json
{
  "success": true,
  "data": [
    {
      "id": "b1d6f0a7-4e28-4b93-90c5-7f2a8c1d3e64",
      "channelId": "cc99cae6-56b4-46ab-9f4a-8b2462d8137c",
      "type": "vod",
      "referenceId": "8c2c4ef1-1c2a-4a49-9c5b-8f9c0a7c3d21",
      "name": "Morning headlines",
      "startTime": "2026-09-02T18:00:00Z",
      "endTime": "2026-09-02T18:10:30Z",
      "duration": "00:10:30",
      "sourceResolution": "1080p",
      "thumbnail": "https://images.fastpix.com/8c2c4ef1-1c2a-4a49-9c5b-8f9c0a7c3d21/thumbnail.png",
      "segments": [],
      "createdAt": "2026-08-20T09:02:11.114530Z",
      "updatedAt": "2026-08-20T09:02:11.114530Z"
    },
    {
      "id": "3e5c7a90-8b2d-4f61-9c07-6d4a1b8e2f53",
      "channelId": "cc99cae6-56b4-46ab-9f4a-8b2462d8137c",
      "type": "live",
      "name": "Evening press conference",
      "startTime": "2026-09-02T19:00:00Z",
      "endTime": "2026-09-02T20:00:00Z",
      "duration": "01:00:00",
      "sourceResolution": "1080p",
      "segments": [],
      "createdAt": "2026-08-20T09:05:44.210338Z",
      "updatedAt": "2026-08-20T09:05:44.210338Z"
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api.fastpix.com/v1/cloud-playout/channels/cc99cae6-56b4-46ab-9f4a-8b2462d8137c/schedule-event"

payload = { "event": {
        "type": "vod",
        "startTime": "2026-09-02T18:00:00",
        "referenceId": "8c2c4ef1-1c2a-4a49-9c5b-8f9c0a7c3d21"
    } }
headers = {
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers, auth=("<username>", "<password>"))

print(response.json())
```

```javascript
const url = 'https://api.fastpix.com/v1/cloud-playout/channels/cc99cae6-56b4-46ab-9f4a-8b2462d8137c/schedule-event';
const credentials = btoa("<username>:<password>");

const options = {
  method: 'POST',
  headers: {
    Authorization: `Basic ${credentials}`,
    'Content-Type': 'application/json'
  },
  body: '{"event":{"type":"vod","startTime":"2026-09-02T18:00:00","referenceId":"8c2c4ef1-1c2a-4a49-9c5b-8f9c0a7c3d21"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fastpix.com/v1/cloud-playout/channels/cc99cae6-56b4-46ab-9f4a-8b2462d8137c/schedule-event"

	payload := strings.NewReader("{\n  \"event\": {\n    \"type\": \"vod\",\n    \"startTime\": \"2026-09-02T18:00:00\",\n    \"referenceId\": \"8c2c4ef1-1c2a-4a49-9c5b-8f9c0a7c3d21\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.SetBasicAuth("<username>", "<password>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.fastpix.com/v1/cloud-playout/channels/cc99cae6-56b4-46ab-9f4a-8b2462d8137c/schedule-event")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request.basic_auth("<username>", "<password>")
request["Content-Type"] = 'application/json'
request.body = "{\n  \"event\": {\n    \"type\": \"vod\",\n    \"startTime\": \"2026-09-02T18:00:00\",\n    \"referenceId\": \"8c2c4ef1-1c2a-4a49-9c5b-8f9c0a7c3d21\"\n  }\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.fastpix.com/v1/cloud-playout/channels/cc99cae6-56b4-46ab-9f4a-8b2462d8137c/schedule-event")
  .basicAuth("<username>", "<password>")
  .header("Content-Type", "application/json")
  .body("{\n  \"event\": {\n    \"type\": \"vod\",\n    \"startTime\": \"2026-09-02T18:00:00\",\n    \"referenceId\": \"8c2c4ef1-1c2a-4a49-9c5b-8f9c0a7c3d21\"\n  }\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.fastpix.com/v1/cloud-playout/channels/cc99cae6-56b4-46ab-9f4a-8b2462d8137c/schedule-event', [
  'body' => '{
  "event": {
    "type": "vod",
    "startTime": "2026-09-02T18:00:00",
    "referenceId": "8c2c4ef1-1c2a-4a49-9c5b-8f9c0a7c3d21"
  }
}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
    'auth' => ['<username>', '<password>'],
]);

echo $response->getBody();
```

```csharp
using RestSharp;
using RestSharp.Authenticators;

var client = new RestClient("https://api.fastpix.com/v1/cloud-playout/channels/cc99cae6-56b4-46ab-9f4a-8b2462d8137c/schedule-event");
client.Authenticator = new HttpBasicAuthenticator("<username>", "<password>");
var request = new RestRequest(Method.POST);

request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"event\": {\n    \"type\": \"vod\",\n    \"startTime\": \"2026-09-02T18:00:00\",\n    \"referenceId\": \"8c2c4ef1-1c2a-4a49-9c5b-8f9c0a7c3d21\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let credentials = Data("<username>:<password>".utf8).base64EncodedString()

let headers = [
  "Authorization": "Basic \(credentials)",
  "Content-Type": "application/json"
]
let parameters = ["event": [
    "type": "vod",
    "startTime": "2026-09-02T18:00:00",
    "referenceId": "8c2c4ef1-1c2a-4a49-9c5b-8f9c0a7c3d21"
  ]] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.fastpix.com/v1/cloud-playout/channels/cc99cae6-56b4-46ab-9f4a-8b2462d8137c/schedule-event")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```