...

/

Modify Stream Schedules

Modify Stream Schedules

Learn to update your Twitch stream schedule.

Set vacation details

The Twitch API allows us to update the settings of stream schedules. We send a PATCH request to the schedule settings endpoint of the API and set vacation details for our channel. We can set vacation details to specify a vacation period where all scheduled streams will be automatically canceled.

The URL for this endpoint is as follows:

https://api.twitch.tv/helix/schedule/settings

All calls to this endpoint must be authenticated with a user access token that has the channel:manage:schedule scope.

Input parameters

This endpoint requires a single query parameter with a few other optional parameters. The table below gives an overview of these parameters:

Parameter

Type

Category

Description

broadcaster_id

String

Required

This is the ID of the user for whom we want to update the schedule settings. It must be of the same user who is authenticated with the access token.

is_vacation_enabled

Boolean

Optional

We set this to true if we're adding vacation details and to false if we're removing already defined vacations.

vacation_start_time

String

Optional

This is an RFC3339 timestamp for the starting date of the vacation period. This parameter is required if is_vacation_enabled is set to true.

vacation_end_time

String

Optional

This is an RFC3339 timestamp for the ending date of the vacation period. This parameter is required if is_vacation_enabled is set to true.

timezone

String

Optional

This is the timezone in the IANA time zone database format. This parameter is required if is_vacation_enabled is set to true.

Example call

Let's make a sample ...