Users

Deleting a User

Changed on

Upon User deletion:

  • The account will be removed,

  • the user will be logged out of all existing sessions,

  • and should the user attempt to reset their password, they will receive an email informing them that their account has been removed.

The User record will remain on file within the database, so that when for example information about the creator of a Form or Submission is requested, basic details are still available on file. A new User account may be created with the same email address as any deleted accounts.

delete/v1/users/{actorId}

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/users/{actorId}
  • Auth
    none declared

Path parameters

actorIdstring required

Typically the integer ID of the User. For getting user details, you can also supply the text current, which will tell you about the currently authenticated user.

Response

OK

successboolean required

Example response

{
  "success": true
}

Changes