DELETE
/
api
/
v4
/
users
/
{userId}
Delete a User
curl --request DELETE \
  --url https://apix.us.amity.co/api/v4/users/{userId} \
  --header 'Authorization: Bearer <token>'
{
  "success": true
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
userId
string
required

User public id

Query Parameters

​
deleteAll
boolean
default:false

true - it will hard delete this user created channels, messages, comments, posts, polls, reactions after user is deleted.

​
markMessageDeleted
boolean
default:false

true - it will hard delete this user messages after user is deleted.

​
hardDeletePost
boolean
default:false

true - it will hard delete this user posts after user is deleted.

​
hardDeleteComment
boolean
default:false

true - it will hard delete this user comments after user is deleted.

Response

return success:'true' when deletion is successful

​
success
boolean
Example:

true