Users: RemoveUser

Removes the specified user from the specified account.

Permissions

To remove a user who has a lower access level, you must have the canRemoveCompanyMemberLowerAccessLevel permission set to true.

To remove a user who has the same access level, you must have the canRemoveCompanyMemberSameAccessLevel permission set to true.

Request

HTTP request

DELETE /restapi/v2/accounts/{accountId}/users/{userId}

Parameters

Parameter NameValueDescription
Path Parameters
userIdinteger

(Required) The id of the user.

accountIdstring

(Required) The globally unique identifier (GUID) for the account.

Responses

CodeDescriptionReference
204

The User was successfully removed.

400

The User could not be removed.

ApiError
401

Not authorized to make this request.

ApiError

SDK Method

Users::RemoveUser

Definitions

ApiError

This object describes errors that occur. It is valid only for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

}} />