deleteUser
Permanently delete a user record by ID for GDPR requests, test cleanup, or confirmed duplicates. Use with delete_images=1 to also remove stored images.
Instructions
Delete a member/user - Permanently delete a user record by ID. Destructive - cannot be undone via API.
Use when: the member record truly must be purged (GDPR request, test cleanup, confirmed duplicate). For reversible removal prefer updateUser with active=3 (Canceled) - the record stays queryable and can be reactivated. Use delete_images=1 to also purge stored profile/cover/logo images.
Required: user_id.
Parameter interactions:
delete_images=1(optional) - also deletes the member's stored profile/cover/logo images from site storage
See also: updateUser (modify without removing).
Destructive: confirm intent with the user before bulk use. No soft-delete via API - records removed are not recoverable.
Returns: { status: "success", message: "record was deleted" }. No body beyond the confirmation string.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes | ||
| delete_images | No | Set to 1 to also delete user images |