Добавление пользователя в команду

Метод TeamManagement.addUser позволяет пригласить нового пользователя в вашу команду. Чтобы отправить приглашение, нужно указать email пользователя.

В команду могут быть добавлены только незарегистрированные пользователи или зарегистрированные пользователи, у которых бесплатный тарифный план и не имели ранее оплаченного тарифного плана.

Вы также можете добавить пользователя используя Serpstat интерфейс.

Общие параметры запроса и инструкция по использованию Serpstat API

Параметры запроса
Параметр	Описание	Тип данных	Обязательный	Варианты значений
id	Идентификатор запроса: ответ содержит этот же идентификатор. Введите любое числовое (number) или текстовое (string) значение.	int/string	да	Числовое или текстовое значение, например: 1, тест
method	Название метода API	string	да	TeamManagement.addUser
params	Объект с параметрами {...}, в нем перечисляются все нижеследующие параметры и массивы [...]	array	да
email	Email приглашаемого пользователя	string	да	Действующий email-адрес, например: johndoe@example.test

Параметры ответа
Параметр	Описание
id	Идентификатор запроса: соответствует id в запросе
result	Содержит в себе ответ
success	Указывает на успех операции
email	email приглашенного пользователя
user_id	ID приглашенного пользователя
limits	Содержит информацию о лимитах команды
total	Максимальный размер команды. (Может быть увеличен, для этого свяжитесь с нами)
used	Количество занятых мест в команде
left	Количество доступных мест в команде

Лимиты: этот метод не списывает лимитов.

Example

Request data:

{
    "id": "1",
    "method": "TeamManagement.addUser",
    "params": {
        "email": "johndoe@example.test"
    }
}

Response data:

{
    "id": "1",
    "result": {
        "success": true,
        "email": "johndoe@example.test",
        "user_id": 123456,
        "limits": {
            "total": 7,
            "used": 1,
            "left": 6
        }
    }
}