Перейти к содержимому

Массовый импорт сотрудников

Массовый импорт сотрудников

POST https://gptunnel.ru/api/v1/employees/importEmployees

Массово создаёт аккаунты сотрудников по списку email. Для каждого адреса email становится логином, пароль генерируется автоматически, а доступы отправляются письмом. Каждый адрес обрабатывается независимо: невалидные и уже состоящие в организации не отменяют обработку остальных.

Если аккаунт с таким email уже зарегистрирован в сервисе и не состоит в вашей организации, новый аккаунт не создаётся: человеку отправляется приглашение в организацию, как при приглашении из личного кабинета. Такой адрес считается в created, как и новый. Сотрудник появится в организации, когда примет приглашение, а до этого в списке сотрудников у него виден только логин. Аккаунт, созданный другой организацией, в чужую организацию не приглашается: ответ тот же, но сотрудник в списке не появится.

Headers

ПараметрТипОписание
Authorization*stringAPI ключ

Параметры запроса

ПараметрТипОписание
emails*string[]Массив email (от 1 до 25). Email используется как логин

Причины ошибок

ПараметрТипОписание
invalid_emailstringНеверный формат email
already_existsstringСотрудник с таким логином или email уже есть в организации
errorstringНепредвиденная ошибка при создании

Пример запроса

Окно терминала
curl --request POST \
--url https://gptunnel.ru/api/v1/employees/importEmployees \
--header 'Authorization: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"emails": ["ivanov@example.com", "petrov@example.com"]
}'

Пример ответа

{
"code": 0,
"created": 1,
"failed": 1,
"failedEmails": [
{
"email": "petrov@example.com",
"reason": "already_exists",
"message": "Employee with this login or email is already in the organization."
}
]
}