Add user to the team
The TeamManagement.addUser method invites new user to join your team. In order to send invitation you need to specify the user's email.
Only unregistered users or registered users who are on the Free plan and didn't have paid plan earlier can be invited to the team.
You also can add 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.addUser |
params | The object with parameters {...}, it lists all the following parameters and arrays [...] | array | yes |
|
| Email of the user to be invited | string | yes | Valid email, for example: johndoe@example.test |
Response parameters | |
Parameter | Description |
id | Response id: corresponds the request id |
result | Contains the answer |
success | Indicates operation success |
email | Invited user's email |
user_id | Invited user's ID |
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 doesn't charge credits.
{
"id": "1",
"method": "TeamManagement.addUser",
"params": {
"email": "johndoe@example.test"
}
}
{
"id": "1",
"result": {
"success": true,
"email": "johndoe@example.test",
"user_id": 123456,
"limits": {
"total": 7,
"used": 1,
"left": 6
}
}
}