GEgetstream
product:chat

Deactivate user

Changed on

Deactivates user with possibility to activate it back

Sends events:

  • user.deactivated
post/users/{user_id}/deactivate

Request

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

Path parameters

user_idstring required

Request body

created_by_idstring

ID of the user who deactivated the user

mark_messages_deletedboolean

Makes messages appear to be deleted

Response

Successful 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

  • d274674f0337Revision changes
    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • info

      added the optional property /// to the response with the status