Get Blocked Terms

Gets an array of blocked terms from a Twitch channel.

This is an Async (Purple) Command, which operates differently from standard commands.

Box Name	Type	Description
Channel	String	Channel name to get blocked terms of
Save Variable As	String	Variable to save the result

Saved Payload:

Variable Name	Type	Description
default	Array	Array of objects representing each blocked term
default[`0-?`]	Object	contains info for a blocked term
default[`0-?`].broadcaster_id	String	The broadcaster’s ID
default[`0-?`].created_at	String	The UTC date and time, in RFC3339 format, of when the blocked term was created. Will be an empty string if the user is banned.
default[`0-?`].expires_at	String	The UTC date and time, in RFC3339 format, of when the blocked term expires. Will be `null` if there is no set expiration.
default[`0-?`].id	String	The blocked term’s unique identifier
default[`0-?`].moderator_id	String	The ID of the moderator who added the blocked term
default[`0-?`].text	String	The blocked term itself!
default[`0-?`].updated_at	String	The UTC date and time, in RFC3339 format, of when the blocked term was updated.

Twitch API Endpoint: GET /helix/moderation/blocked_terms

Example SAMMI Response Object:

[
  {
    "broadcaster_id": "98765432",
    "moderator_id": "33333333",
    "id": "520e4d16-5379-4bbe-a824-8d5a847e05c4",
    "text": "badword",
    "created_at": "2022-01-01T00:00:00Z",
    "updated_at": "2022-01-01T00:00:00Z",
    "expires_at": null
  }
]

Note: SAMMI saves the raw data array directly (as struct_to_map(data)), so the variable stores an array-as-map where the key default holds the array of blocked term objects.

Back to the list