Skip to main content
POST
Erase a user (GDPR Art. 17). Irreversible. Run the preview first. Admin session only.

Authorizations

Authorization
string
header
required

JWT access token for user authentication (Authorization: Bearer <jwt_token>). Create via POST /users/me/access_tokens.

Path Parameters

user_id
string
required

User ID

Body

application/json
confirm_email
string
required

Must match the user's current email, ignoring case and surrounding whitespace. Typed by the operator as a guard against erasing the wrong id.

requested_at
string<date-time> | null

When the person asked (starts the GDPR response clock). Defaults to now.

Response

User erased (or already erased)

already_erased
boolean
required
erased_organization_ids
string[]
required
lifecycle
enum<string>
required

Account state derived only from operator-owned columns (users.is_active + users.auth_provider). Serialized as active, deactivated or erased; this lowercase spelling is part of the public API vocabulary.

Available options:
active,
deactivated,
erased
user_id
string
required