admin

Delete a user (admin)

Changed on

Delete a user. With mode=now the user is removed immediately. With mode=scheduled (the default, matching the CLI) the user receives a confirmation email and is scheduled for deletion just like a self-initiated account deletion.

delete/admin/users/{id}

Request

  • Base URL
    /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v1/admin/users/{id}
  • Auth
    API key in header Authorization

Path parameters

idinteger required

User ID

Query parameters

modestring

Deletion mode: 'now' for immediate deletion, 'scheduled' (default) to trigger the email-confirmation self-deletion flow.

Response

No Content

Changes