Delete User

Deletes or marks as deleted a particular account user.

The data to be submitted to the API is composed of the following fields:

Notes:

• ONLY users with Administrator-level permissions can make this API call.
• The action = permanent parameter is optional. Normally, this parameter is NOT passed, to prevent situations where if a user is permanently deleted and another user is created later with the same user_name, and since user_names are stored with transactions to identify the person who processed the transaction, a new user could "inherit" the transactions of a previously same-named user. (This would not be affected across accounts.) If you want to ignore this consequence, then add the action = permanent to the parameters passed.

Example PHP Request:

If you are using PHP, the $data array would look like this:

1. $data['user_id'] = 'john1970';
2. $data['user_password'] = '1959caadac9b13dcb3';
3. $data['type'] = 'user_delete';
4. $data['account_id'] = 'greatwidgets';
5. $data['user_name'] = 'fired_clerk';

Success XML Response:

1. <response status="success">
2. </response>

Error XML Response:

1. <response status="error">
2. <error>Error message</error>
3. </response>