GEgetstream
product:chat

Create block list

Changed on

Creates a new application blocklist, once created the blocklist can be used by any channel type

post/blocklists

Request

  • Base URL
    https://chat.stream-io-api.com
  • URL
    https://chat.stream-io-api.com/blocklists
  • Auth
    • API key in header Authorization and API key in query parameter api_key and API key in header Stream-Auth-Type
    • or API key in query parameter api_key and API key in header Stream-Auth-Type

Request body

is_confusable_folding_enabledboolean
is_leet_check_enabledboolean
is_plural_check_enabledboolean
is_substring_matching_enabledboolean
namestring required

Block list name

teamstring
type'regex' | 'domain' | 'domain_allowlist' | 'email' | 'email_allowlist' | 'word' | 'word_allowlist'

Block list type. One of: regex, domain, domain_allowlist, email, email_allowlist, word, word_allowlist

user_idstring
wordsstring[] required

List of words to block

Response

Response

durationstring required

Duration of the request in milliseconds

Changes

  • 30f95dce0284Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • cbe7207678c9Revision changes
    • info

      added the new word_allowlist enum value to the request property