TwitchApi.Schedule.UpdateChannelStreamSchedule (TwitchApi v0.1.2) View Source

⛔ This module is autogenerated please do not modify manually.

Example request from twitch api docs:

descriptions:

Enable Vacation Mode and specify vacation dates for the TwitchDev channel’s stream schedule.

requests:

curl -X PATCH 'https://api.twitch.tv/helix/schedule/settings?broadcaster_id=141981764&is_vacation_enabled=true&vacation_start_time=2021-05-16T00:00:00Z&vacation_end_time=2021-05-23T00:00:00Z&timezone=America/New_York'
-H'Authorization: Bearer cfabdegwdoklmawdzdo98xt2fo512y'
-H'Client-Id: uo6dggojyb8d6soh92zknwmi5ej1q2'

Example response from twitch api docs:

descriptions:

responses:

204NoContent

Link to this section Summary

Types

User ID of the broadcaster who owns the channel streaming schedule. Provided broadcaster_id must match the user_id in the user OAuth token.Maximum: 1

Indicates if Vacation Mode is enabled. Set to true to add a vacation or false to remove vacation from the channel streaming schedule.

The timezone for when the vacation is being scheduled using the IANA time zone database format. Required if is_vacation_enabled is set to true.

Map containing the user needed information for the fetch of the required user OAuth access token. You will be able to choose from one way or the other for fetching previously OAuth access tokens. :user_id field contains the user ID from twitch, e.g. 61425548 or "61425548" :user_name field constains the user name from twitch, e.g. "hiimkamiyuzu"

End time for vacation specified in RFC3339 format. Required if is_vacation_enabled is set to true.

Start time for vacation specified in RFC3339 format. Required if is_vacation_enabled is set to true.

Functions

Description:

NEW Update the settings for a channel’s stream schedule.

Link to this section Types

Specs

broadcaster_id() :: %{broadcaster_id: String.t()}

User ID of the broadcaster who owns the channel streaming schedule. Provided broadcaster_id must match the user_id in the user OAuth token.Maximum: 1

Specs

is_vacation_enabled() :: %{is_vacation_enabled: boolean()}

Indicates if Vacation Mode is enabled. Set to true to add a vacation or false to remove vacation from the channel streaming schedule.

Specs

timezone() :: %{timezone: String.t()}

The timezone for when the vacation is being scheduled using the IANA time zone database format. Required if is_vacation_enabled is set to true.

Specs

user_info() :: %{user_id: integer() | binary()} | %{user_name: binary()}

Map containing the user needed information for the fetch of the required user OAuth access token. You will be able to choose from one way or the other for fetching previously OAuth access tokens. :user_id field contains the user ID from twitch, e.g. 61425548 or "61425548" :user_name field constains the user name from twitch, e.g. "hiimkamiyuzu"

Specs

vacation_end_time() :: %{vacation_end_time: String.t()}

End time for vacation specified in RFC3339 format. Required if is_vacation_enabled is set to true.

Specs

vacation_start_time() :: %{vacation_start_time: String.t()}

Start time for vacation specified in RFC3339 format. Required if is_vacation_enabled is set to true.

Link to this section Functions

Specs

Description:

NEW Update the settings for a channel’s stream schedule.

Required authentication:

Required authorization:

User OAuth TokenRequired scope: channel:manage:schedule