Get Pinned Chat Message
Gets the currently pinned Twitch chat message for the selected channel and saves the response to a variable. For more information on the response object, see the Twitch API Reference Guide for Get Pinned Chat Message.
This is an Async (Purple) Command, which operates differently from standard commands.
| Box Name | Type | Description |
|---|---|---|
| Channel | Dropdown | Twitch channel to read the pinned message from. Leave empty to use the default account. |
| Save Variable As | String | Variable name to save the pinned message object. Saves undefined if no pinned message exists. |
Saved Payload:
SAMMI saves the first pinned message object returned by Twitch (data[0]).
| Variable Name | Type | Description |
|---|---|---|
| message_id | String | ID of the pinned chat message. |
| created_at | String | Time in Twitch format when the message was pinned. |
| updated_at | String | Time in Twitch format when the pinned message was last updated. |
| expires_at | String | Time in Twitch format when the pin expires, if Twitch returns one. |
| duration_seconds | Number | Pin duration in seconds, if Twitch returns one. |
Requires the
moderator:read:chat_messages or moderator:manage:chat_messages Twitch scope.
Twitch API Endpoint: GET /helix/chat/pins
| Request Field | Type | Description |
|---|---|---|
| broadcaster_id | String | The ID of the broadcaster whose channel to get the pinned message from |
| moderator_id | String | The ID of the moderator or broadcaster making the request |