Schedule
Scheduled streaming events for Kaleo Connect devices.
List scheduled events
List scheduled events, newest first.
Path Parameters
churchIdYour church ID. Copy it from the API page (under Integrations) in your dashboard.
Query Parameters
pagePage number, starting at 1. Values above the last page return the last page.
pageSizeEvents per page. Values above 100 use 100.
List scheduled events › Responses
Success
totalTotal matching scheduled events, across all pages.
pagePage returned; may be lower than requested.
pageSizeGet scheduled event
Read one scheduled event.
Path Parameters
churchIdYour church ID. Copy it from the API page (under Integrations) in your dashboard.
eventIdScheduled event ID from GET /schedule.
Get scheduled event › Responses
Success
Create scheduled event
Create a scheduled event. Omitted streaming settings use saved church defaults.
Path Parameters
churchIdYour church ID. Copy it from the API page (under Integrations) in your dashboard.
Create scheduled event › Request Body
namedeviceIdKaleo Connect device ID from GET /devices.
startsAt^\d{4}-\d{2}-\d{2}T\… · requiredStart date and time in local time, without a timezone offset. Interpreted in timezone.
timezoneIANA timezone, such as America/Toronto. Repeats follow local time; daylight saving gaps are skipped and repeated times run once.
repeatRepeat frequency. Defaults to "once" when creating an event.
weekdaysDays for weekly repeats. Required when repeat is "weekly"; otherwise empty.
speakerLanguageCode from GET /languages/speaker. Use "mul" for Multilingual mode.
targetLanguagesCodes from GET /languages/target. Use ["ALL"] for all supported targets, within your plan limit.
durationTime until automatic stop, in seconds.
Choose the ProPresenter source for this session. Configure its connection in Connect.
Create scheduled event › Responses
Success
Update scheduled event
Change a scheduled event. Omitted fields keep their current values. Changes apply to future starts.
Path Parameters
churchIdYour church ID. Copy it from the API page (under Integrations) in your dashboard.
eventIdScheduled event ID from GET /schedule.
Update scheduled event › Request Body
namedeviceIdKaleo Connect device ID from GET /devices.
startsAt^\d{4}-\d{2}-\d{2}T\…Start date and time in local time, without a timezone offset. Interpreted in timezone.
timezoneIANA timezone, such as America/Toronto. Repeats follow local time; daylight saving gaps are skipped and repeated times run once.
repeatRepeat frequency. Defaults to "once" when creating an event.
weekdaysDays for weekly repeats. Required when repeat is "weekly"; otherwise empty.
speakerLanguageCode from GET /languages/speaker. Use "mul" for Multilingual mode.
targetLanguagesCodes from GET /languages/target. Use ["ALL"] for all supported targets, within your plan limit.
durationTime until automatic stop, in seconds.
Choose the ProPresenter source for this session. Configure its connection in Connect.
Update scheduled event › Responses
Success
Remove scheduled event
Remove a scheduled event and cancel its future starts. A stream already in progress continues.
Path Parameters
churchIdYour church ID. Copy it from the API page (under Integrations) in your dashboard.
eventIdScheduled event ID from GET /schedule.
Remove scheduled event › Responses
Success
eventIdremoved