GEgetstream
product:chat

Claim guest user

Changed on

Claims a guest user for a regular user. The guest is deactivated and its channel memberships, owned channels, messages and reactions are moved to the claiming user by an asynchronous task. Server-side only.

Sends events:

  • user.claimed
  • user.deactivated
post/users/claim_guest

Request

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

guest_user_idstring required

ID of the guest user to claim

user_idstring required

ID of the regular user that claims the guest and receives its channels, messages and reactions

Response

Successful response

durationstring required

Duration of the request in milliseconds

task_idstring required

ID of the task that moves the guest's channels, messages and reactions to the claiming user

Changes