GEgetstream
product:chat

Deactivate users

Changed on

Deactivate users in batches

Sends events:

  • user.deactivated
post/users/deactivate

Request

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

created_by_idstring

ID of the user who deactivated the users

mark_channels_deletedboolean
mark_messages_deletedboolean

Makes messages appear to be deleted

user_idsstring[] required

User IDs to deactivate

Response

Response

durationstring required

Duration of the request in milliseconds

task_idstring required

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

  • 3b611b5cf468Revision changes
    • breaking

      the request property's minItems was increased to 1