The Schedule API allows you to manage schedule entries associated with live channels that support scheduled assets and ad breaks. This API provides endpoints for adding, retrieving, updating, and deleting schedule entries to help automate live content scheduling.
Note: This API is only compatible with live channels that can leverage schedule entries. Learn more.
Key Features
- Add and manage schedule entries for live channels.
- Bulk operations for adding playlists or removing multiple scheduled entries.
- Retrieve schedules for a given time period or specific entries.
- Modify existing schedules to adjust assets and ad breaks.
Schedule Entry Management
Schedule entries define when assets and ad breaks will be played on a live channel. The API provides several endpoints for managing these entries.
Available Endpoints
| Endpoint | Description |
|---|---|
| Add Schedule EntryPOST /channels/{Live Channel ID}/schedules | Add a schedule entry to a live channel. |
| Add Schedule Entries by PlaylistPOST /channels/{Live Channel ID}/schedule-playlist | Add a playlist’s assets and ad breaks as schedule entries for a live channel. |
| Delete Multiple Schedule EntriesDELETE /channels/{Live Channel ID}/schedules | Delete all schedule entries that fall within a specified date range. |
| Delete Schedule Entry / Linked Schedule EntriesDELETE /channels/{Live Channel ID}/schedules/{Schedule Entry ID} | Delete a specific schedule entry from a live channel. |
| Delete Schedule Entry / Linked Schedule EntriesDELETE /channels/{Live Channel ID}/schedules/{Schedule Entry ID}?include_linked=true | Delete a schedule entry and all linked entries associated with a playlist. |
| Get Multiple Schedule EntriesGET /channels/{Live Channel ID}/schedules | Retrieve all schedule entries for a live channel within a specified time period. |
| Get Schedule EntryGET /channels/{Live Channel ID}/schedules/{Schedule Entry ID} | Retrieve details of a specific schedule entry. |
| Update Schedule EntryPATCH /channels/{Live Channel ID}/schedules/{Schedule Entry ID} | Update a specific schedule entry. |
Base URL
Use the following base URL for API requests:
https://services.uplynk.com/api/v4