TwurpleAuthenticationGetting dataExamplesFAQMigration

Main classes

HelixCreateScheduleSegmentData

The data required to create a schedule segment.

{
The ID of the category of the segment.
categoryId?: string
The planned duration of the segment, in minutes. Defaults to 240 (4 hours).
duration?: number
Whether the segment is recurring every week.
isRecurring: boolean
The date when the segment starts. Must be in UTC.
startDate: string
The timezone the segment is created from.
timezone: string
The title of the segment.
title?: string
}

Properties

categoryId

Type: ?string

The ID of the category of the segment.

duration

Type: ?number

The planned duration of the segment, in minutes. Defaults to 240 (4 hours).

isRecurring

Type: boolean

Whether the segment is recurring every week.

startDate

Type: string

The date when the segment starts. Must be in UTC.

timezone

Type: string

The timezone the segment is created from.

This is used for managing DST shifts only. The startDate must always be given in UTC.

title

Type: ?string

The title of the segment.