TwurpleAuthenticationGetting dataExamplesFAQMigration

Main classes

HelixSendChatAnnouncementParams

A request to send an announcement to a broadcaster's chat.

{
The color used to highlight the announcement. If color is set to `primary` or is not set, the channel’s accent color is used to highlight the announcement.
color?:
HelixChatAnnouncementColor

The color used to highlight an announcement.

Aliased type: "blue" | "green" | "orange" | "purple" | "primary"

The announcement to make in the broadcaster's chat room. Announcements are limited to a maximum of 500 characters; announcements longer than 500 characters are truncated.
message: string
}

Properties

color

Type:
HelixChatAnnouncementColor

The color used to highlight an announcement.

Aliased type: "blue" | "green" | "orange" | "purple" | "primary"

The color used to highlight the announcement. If color is set to primary or is not set, the channel’s accent color is used to highlight the announcement.

message

Type: string

The announcement to make in the broadcaster's chat room. Announcements are limited to a maximum of 500 characters; announcements longer than 500 characters are truncated.