TwitchApi.Chat.UpdateUserChatColor (TwitchApi v0.1.3) View Source

⛔ This module is autogenerated please do not modify manually.

Example request from twitch api docs:

descriptions:

Uses a named color to change the color that the user uses for their name in chat. Uses a color Hex code to change the color that the user uses for their name in chat.

requests:

curl -X PUT 'https://api.twitch.tv/helix/chat/color?user_id=123&color=%239146FF'
-H'Authorization: Bearer kpvy3cjboyptmdkiacwr0c19hotn5s'
-H'Client-Id: hof5gwx0su6owfnys0nyan9c87zr6t' curl -X PUT 'https://api.twitch.tv/helix/chat/color?user_id=123&color=blue'
-H'Authorization: Bearer kpvy3cjboyptmdkiacwr0c19hotn5s'
-H'Client-Id: hof5gwx0su6owfnys0nyan9c87zr6t'

Example response from twitch api docs:

descriptions:

responses:

Link to this section Summary

Types

The color to use for the user’s name in chat. All users may specify one of the following named color values.blueblue_violetcadet_bluechocolatecoraldodger_bluefirebrickgolden_rodgreenhot_pinkorange_redredsea_greenspring_greenyellow_greenTurbo and Prime users may specify a named color or a Hex color code like #9146FF. If you use a Hex color code, remember to URL encode it.

The ID of the user whose chat color you want to update.

Functions

Description:

NEW Updates the color used for the user’s name in chat.

Link to this section Types

Specs

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

The color to use for the user’s name in chat. All users may specify one of the following named color values.blueblue_violetcadet_bluechocolatecoraldodger_bluefirebrickgolden_rodgreenhot_pinkorange_redredsea_greenspring_greenyellow_greenTurbo and Prime users may specify a named color or a Hex color code like #9146FF. If you use a Hex color code, remember to URL encode it.

Specs

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

The ID of the user whose chat color you want to update.

Link to this section Functions

Specs

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

Description:

NEW Updates the color used for the user’s name in chat.

Required authentication:

Required authorization:

Requires a user access token that includes the user:manage:chat_color scope. The ID in the user_id query parameter must match the user ID in the access token.