TwitchApi.Moderation.RemoveChannelVIP (TwitchApi v0.1.3) View Source

⛔ This module is autogenerated please do not modify manually.

Example request from twitch api docs:

descriptions:

Removes the VIP from the broadcaster’s chat room.

requests:

curl -X DELETE 'https://api.twitch.tv/helix/channels/vips?broadcaster_id=123&user_id=456'
-H'Authorization: Bearer kpvy3cjboyptmdkiacwr0c19hotn5s'
-H'Client-Id: hof5gwx0su6owfnys0nyan9c87zr6t'

Example response from twitch api docs:

descriptions:

responses:

Link to this section Summary

Types

broadcaster_id()

The ID of the broadcaster that’s removing VIP status from the user.

user_id()

The ID of the user to remove as a VIP from the broadcaster’s chat room.

Functions

call(map)

Description:

NEW Removes a VIP from the broadcaster’s chat room.

Link to this section Types

broadcaster_id()

Specs

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

The ID of the broadcaster that’s removing VIP status from the user.

user_id()

Specs

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

The ID of the user to remove as a VIP from the broadcaster’s chat room.

Link to this section Functions

call(map)

Specs

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

Description:

NEW Removes a VIP from the broadcaster’s chat room.

Required authentication:

Required authorization:

Requires a user access token that includes the channel:manage:vips scope. The ID in the broadcaster_id query parameter must match the user ID in the access token.