Remove user from the team

The TeamManagement.removeUser method removes existing user from your team. In order to remove user you need to specify the user's ID. User's ID can be found using TeamManagement.getList method.

By default, all projects will be transferred to the main team account.

You also can remove users using Serpstat interface.

General request parameters and instructions for using Serpstat API

Request parameters
Parameter	Description	Type	Required	Default value	Value options
id	A request id: the response contains the same id. Enter any number (number) or text (string) value	int/string	yes		Any text or number value, for example: 1, test
method	API method name	string	yes		TeamManagement.removeUser
params	The object with parameters {...}, it lists all the following parameters and arrays [...]	array	yes
user_id	ID of the user to be removed	int	yes		Number value of the user's ID, for example: 12345
merge_projects	The policy to be applied for user's existing projects.	bool	no	true	true - transfer user's projects to the team owner false - remove user's projects

Response parameters
Parameter	Description
id	Response id: corresponds the request id
result	Contains the answer
success	Indicates operation success
user_id	ID of the user to be removed
limits	Contains information about team limits
total	Maximum team size. (Can be increased, contact us)
used	Already used team seats
left	Available team seats

Credits: this method does not charge credits.

Example

Request data:

{
    "id": "1",
    "method": "TeamManagement.removeUser",
    "params": {
        "user_id": 12345,
        "merge_projects": true
    }
}

Response data:

{
    "id": "1",
    "result": {
        "success": true,
        "user_id": 12345,
        "limits": {
            "total": 7,
            "used": 1,
            "left": 6
        }
    }
}