Users

users_users_delete

Soft-delete an end user: the record is retained with `deletedAt` set and disappears from the default list.

Tool

users_users_delete

Soft-delete an end user: the record is retained with `deletedAt` set and disappears from the default list.

Soft-delete an end user: the record is retained with `deletedAt` set and disappears from the default list. This is NOT GDPR erasure — no data is purged, and the user can still be fetched by id.

Behavior

HTTP: DELETE /users/users/:userId

Arguments

Name	Type	Required	Description
userId	string	•	The opaque user id returned by users_users_create or _list.

Response

Field	Type	Always
id	string	•
name	string	•
bannedAt	string	•
erasedAt	string	•
imageUrl	string	•
testUser	boolean	•
createdAt	string	•
deletedAt	string	•
productId	string	•
updatedAt	string	•
waitlisted	boolean	•
identifiers	array	•
lockedUntil	string	•
lastSignInAt	string	•
requiresReset	boolean	•
publicMetadata	object	•
unsafeMetadata	object	•
privateMetadata	object	•
emailChangeLockedUntil	string	•

Try it

Soft-delete an end user: the record is retained with `deletedAt` set and disappears from the default list.

When to use

Soft-delete an end user: the record is retained with `deletedAt` set and disappears from the default list. This is NOT GDPR erasure — no data is purged, and the user can still be fetched by id.

Example

Ask your agent something like this:

Soft-delete an end user: the record is retained with `deletedAt` set and disappears from the default list.

The agent will invoke users_users_delete with these arguments:

{
  "userId": "<userId>"
}