Deactivate team user

The TeamManagement.deactivateUser method deactivates active user in your teamIn order to deactivate user you need to specify the user's ID. User's ID can be found using TeamManagement.getList method.

You also can deactivate users using Serpstat interface.

General request parameters and instructions for using Serpstat API

Request parameters

Parameter

Description

Type

Required

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.deactivateUser

params

The object with parameters {...}, it lists all the following parameters and arrays [...]

array

yes

user_id

ID of the user to be deactivated

int

yes

Number value of user's ID, for example: 12345

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 deactivated
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.deactivateUser",
    "params": {
        "user_id": 12345
    }
}
Response data:
{
    "id": "1",
    "result": {
        "success": true,
        "user_id": 12345,
        "limits": {
            "total": 7,
            "used": 1,
            "left": 6
        }
    }
}

Share this article with your friends

Are you sure?

Introducing Serpstat

Find out about the main features of the service in a convenient way for you!

Please send a request, and our specialist will offer you education options: a personal demonstration, a trial period, or materials for self-study and increasing expertise — everything for a comfortable start to work with Serpstat.

Name

Email

Phone

We are glad of your comment
I agree to Serpstat`s Privacy Policy.

Thank you, we have saved your new mailing settings.

Open support chat