Skip to navigation

⚠️ Purge User (permanent and irreversible)

⚠️ IRREVERSIBLE ACTION — the user is deleted forever.

Purges (permanently deletes) the user from the organization. Unlike DELETE /users/{id}/ (delete) and POST /users/{id}/deactivate/ (deactivate), which leave the account recoverable, this operation:

  • Modifies the user’s email: the suffix _deleted_<random> is appended (ana@company.com → ana_deleted_qwert@company.com) to release the address so it can be reused by a new account. The original email cannot be recovered through the API.
  • Sets the membership to DELETED and revokes all of its licenses.
  • Removes the user from Learning and Talent.

It cannot be undone. If the user was already deleted, the purge only releases their email. Use it only when permanent deletion is required (e.g. a personal data deletion request).

An id that does not exist or that belongs to another organization returns 400 with User not found: both cases get the same response on purpose, so as not to confirm that the id exists in another client.

Authentication

Api-Keystring

API key of the organization. Always sent together with the Secret-Access header.

Path parameters

organization_slugstringRequired
idintegerRequired

Headers

Secret-AccessstringRequired

Response

Successful Response
messagestring
Message of the response
codestring
Internal code of the response
datetimestring
Datetime of the API in ISO Format
dataanyOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error