GEgetstream
product:chat

Create predefined filter

Changed on

Create a predefined filter that can be used in Query endpoints

post/predefined_filters

Request

  • Base URL
    https://chat.stream-io-api.com
  • URL
    https://chat.stream-io-api.com/predefined_filters
  • 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

descriptionstring

The description of the predefined filter

filterobject required

Filter to apply to the query

namestring required

The unique name of the predefined filter (alphanumeric, _, - only)

operation'QueryChannels' required

The operation this filter is for (e.g., QueryChannels)

sortobject[]

Response

Successful response

durationstring required

Duration of the request in milliseconds

Changes