GEgetstream
product:chat

Update channel type

Changed on

Updates channel type

put/channeltypes/{name}

Request

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

Path parameters

namestring required

Request body

allowed_flag_reasonsstring[]
automod'disabled' | 'simple' | 'AI'
automod_behavior'flag' | 'block' | 'shadow_block'
blockliststring
blocklist_behavior'flag' | 'block' | 'shadow_block'
commandsstring[]

List of commands that channel supports

connect_eventsboolean
count_messagesboolean
custom_eventsboolean
delivery_eventsboolean
grantsobject nullable
mark_messages_pendingboolean
max_message_lengthinteger
message_retentionstring
mutesboolean
partition_sizeinteger
partition_ttlstring duration nullable
pollsboolean
push_level'all' | 'all_mentions' | 'mentions' | 'direct_mentions' | 'none'

Sets the push notification level for a channel type

push_notificationsboolean
quotesboolean
reactionsboolean
read_eventsboolean
remindersboolean
repliesboolean
searchboolean
shared_locationsboolean
skip_last_msg_update_for_system_msgsboolean
typing_eventsboolean
uploadsboolean
url_enrichmentboolean
user_message_remindersboolean

Example request

{
  "partition_ttl": "24h"
}

Response

Successful response

allowed_flag_reasonsstring[]
automod'disabled' | 'simple' | 'AI' required
automod_behavior'flag' | 'block' | 'shadow_block' required
blockliststring
blocklist_behavior'flag' | 'block' | 'shadow_block'
commandsstring[] required
connect_eventsboolean required
count_messagesboolean required
created_atstring date-time required
custom_eventsboolean required
delivery_eventsboolean required
durationstring required

Duration of the request in milliseconds

grantsobject required
mark_messages_pendingboolean required
max_message_lengthinteger required
message_retentionstring required
mutesboolean required
namestring required
partition_sizeinteger
partition_ttlstring duration
pollsboolean required
push_level'all' | 'all_mentions' | 'mentions' | 'direct_mentions' | 'none'

Sets the push notification level for a channel type

push_notificationsboolean required
quotesboolean required
reactionsboolean required
read_eventsboolean required
remindersboolean required
repliesboolean required
searchboolean required
shared_locationsboolean required
skip_last_msg_update_for_system_msgsboolean required
typing_eventsboolean required
updated_atstring date-time required
uploadsboolean required
url_enrichmentboolean required
user_message_remindersboolean required

Example response

{
  "partition_ttl": "24h"
}

Changes

  • 7c37a9bae125Revision changes
    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional

  • 30f95dce0284Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status