TwitchApi.Channels.ModifyChannelInformation (TwitchApi v0.1.3) View Source

⛔ This module is autogenerated please do not modify manually.

Example request from twitch api docs:

descriptions:

requests:

curl -X PATCH 'https://api.twitch.tv/helix/channels?broadcaster_id=41245072'
-H'Authorization: Bearer 2gbdx6oar67tqtcmt49t3wpcgycthx'
-H'Client-Id: wbmytr93xzw8zbg0p1izqyzzc5mbiz'
-H'Content-Type: application/json'
--data-raw'{"game_id":"33214", "title":"there are helicopters in the game? REASON TO PLAY FORTNITE found", "broadcaster_language":"en"}'

Example response from twitch api docs:

descriptions:

responses:

204NoContent

Link to this section Summary

Types

ID of the channel to be updated

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"

Functions

Description:

Modifies channel information for users.

Link to this section Types

Specs

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

ID of the channel to be updated

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"

Link to this section Functions

Link to this function

call(map, body_params, user_info)

View Source

Specs

call(broadcaster_id(), body_params(), user_info()) ::
  {:ok, Finch.Response.t()} | {:error, Exception.t()}

Description:

Modifies channel information for users.

Required authentication:

OAuth Token required Required scope: channel:manage:broadcast

Required authorization: