Delete

Delete an existing user. You can never delete the user that the current actor is using.

Tokens

This action requires the following tokens:

  • user-delete

Arguments

Required arguments are marked in bold, and optional arguments are marked in italics.

Argument Type Default Description
user Hash   The ID of the user to delete

Output

This action produces no output on success.

Errors

This action can return one of the default status codes, or one of the following status codes on error:

STATUS_USER_NOT_FOUND (310)
If the user specified by “user” can not be found
STATUS_ACCESS_DENIED (4)