helix/io.github.captnblubber.twitchkt.helix.resource/ScheduleResource/updateSettings

updateSettings

suspend fun updateSettings(broadcasterId: String, isVacationEnabled: Boolean? = null, vacationStartTime: String? = null, vacationEndTime: String? = null, timezone: String? = null)

Twitch API: Update Channel Stream Schedule

Updates the broadcaster's schedule settings, such as scheduling a vacation.

Parameters

broadcasterId

the ID of the broadcaster whose schedule settings you want to update. The ID must match the user ID in the user access token.

isVacationEnabled

a Boolean value that indicates whether the broadcaster has scheduled a vacation. Set to true to enable Vacation Mode and add vacation dates, or false to cancel a previously scheduled vacation.

vacationStartTime

the UTC date and time of when the broadcaster's vacation starts. Specify the date and time in RFC3339 format. Required if isVacationEnabled is true.

vacationEndTime

the UTC date and time of when the broadcaster's vacation ends. Specify the date and time in RFC3339 format. Required if isVacationEnabled is true.

timezone

the time zone that the broadcaster broadcasts from. Specify the time zone using IANA time zone database format. Required if isVacationEnabled is true.