Delete Own Account

Prev Next
Post
/api/v1/users.deleteOwnAccount

Deletes your own user account. Requires the Allow Users to Delete Own Account setting enabled. Access this setting from Administration > Workspace > Settings > Accounts.

Changelog

Version Description
3.7.0 Added confirmRelinquish to the payload.
0.67.0 Added
Header parameters
X-Auth-Token
stringRequired

The authenticated user token.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The authenticated user ID.

ExamplerbAXPnMktTFbNpwtJ
Body parameters
Example 1
{
  "password": "8f0e2f76e22b43e2855189877e7dc1e1e7d98c226c95db247cd1d547928334a9",
  "confirmRelinquish": false
}
object
password
string Required

The password of user (encrypted in SHA256).

Example8f0e2f76e22b43e2855189877e7dc1e1e7d98c226c95db247cd1d547928334a9
confirmRelinquish
boolean

Deletes own account even if user is the last owner of a room.

Defaultfalse
Responses
200

OK

Success
{
  "success": true
}
object
success
boolean
400

Bad Request

Example 1
{
  "success": false,
  "error": "Body parameter \"password\" is required."
}
object
success
boolean
error
string
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string