API Reference

Delete user

put
https://user-api.omni.chat/v1/users//delete

Soft-deletes a user by its id. Optionally transfers the user's open conversations to another user or team.
Requires admin role.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The ID of an existing user.

Body Params
string

ID of the user to whom the deleted user's conversations will be transferred.

boolean

When true, moves the deleted user's customer portfolio to the target user.

string

ID of the team to which the deleted user's conversations will be transferred.

Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?