Users

Remove a user

Delete a user and revoke all associated sessions.

The Remove User endpoint permanently deletes a user account from the system. This action cannot be undone, and all related sessions, tokens, and associated data will be invalidated.

Endpoint

DELETE /v1/users/{user_id}

Path Parameters

Parameter	Type	Required	Description
user_id	string	Yes	The unique identifier of the user to delete.

Headers

Key	Value	Required
Authorization	Bearer <access_token>	Yes
Content-Type	application/json	No

Response

Successful Response (200 OK)

{
  "message": "User user_123 has been removed successfully.",
  "id": "user_123"
}

Field	Type	Description
message	string	Confirmation message.
id	string	ID of the deleted user.

Error Response (401 / 403 / 404)

{
  "error": "not_found",
  "message": "User not found or already deleted."
}

Error Code	Meaning
not_found	User does not exist or has already been removed.
unauthorized	Missing or invalid access token.
forbidden	Insufficient permissions to delete the user.

Example Usage

cURL

curl -X DELETE "https://api.example.com/v1/users/user_123" \
  -H "Authorization: Bearer admin_access_token"

JavaScript (Fetch)

const response = await fetch("https://api.example.com/v1/users/user_123", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer admin_access_token"
  }
});

const data = await response.json();
console.log(data.message);

Deleting a user is irreversible. If you want to temporarily disable access, consider using the PATCH /v1/users/{id} endpoint to update the user’s status to suspended instead.

Update user details

List all users

Need help? Contact Support

Join our Discord Community

Questions? Contact Sales

On this page

Title