Создание сотрудника
Создание сотрудника
https://gptunnel.ru/api/v1/employees/createEmployee Создаёт аккаунт сотрудника в организации, к которой привязан API-ключ. Сотрудник добавляется в организацию с ролью «Участник». Если указан email, на него отправляется письмо с доступами.
Если аккаунт с таким логином уже зарегистрирован в сервисе и не состоит в вашей организации, новый аккаунт не создаётся: человеку отправляется приглашение в организацию, как при приглашении из личного кабинета. Пароль, имя и телефон из запроса к такому аккаунту не применяются. Сотрудник появится в организации, когда примет приглашение, а до этого в списке сотрудников у него виден только логин. Ответ в этом случае такой же, как при создании нового аккаунта, а userId не связан с аккаунтом приглашённого. Аккаунт, созданный другой организацией, в чужую организацию не приглашается: ответ тот же, но сотрудник в списке не появится.
Headers
| Параметр | Тип | Описание |
|---|---|---|
Authorization* | string | API ключ |
Параметры запроса
| Параметр | Тип | Описание |
|---|---|---|
login* | string | Логин сотрудника (произвольная строка, 1–255 символов) |
password* | string | Пароль (минимум 5 символов) |
email | string | Email. Должен быть уникальным в пределах организации |
firstName | string | Имя |
lastName | string | Фамилия |
phone | string | Телефон (произвольная строка) |
avatar | string | Аватар |
Пример запроса
curl --request POST \ --url https://gptunnel.ru/api/v1/employees/createEmployee \ --header 'Authorization: YOUR_API_KEY' \ --header 'Content-Type: application/json' \ --data '{ "login": "ivanov@example.com", "password": "secret123", "email": "ivanov@example.com", "firstName": "Иван", "lastName": "Иванов"}'import axios from 'axios'
const response = await axios({ method: 'POST', url: 'https://gptunnel.ru/api/v1/employees/createEmployee', headers: { Authorization: 'YOUR_API_KEY', }, data: { login: 'ivanov@example.com', password: 'secret123', email: 'ivanov@example.com', firstName: 'Иван', lastName: 'Иванов', },})
console.log(response.data)import requests
response = requests.post( 'https://gptunnel.ru/api/v1/employees/createEmployee', headers={'Authorization': 'YOUR_API_KEY'}, json={ 'login': 'ivanov@example.com', 'password': 'secret123', 'email': 'ivanov@example.com', 'firstName': 'Иван', 'lastName': 'Иванов', },)
print(response.json())Пример ответа
{ "code": 0, "userId": "66a346f64dcb57627c03d596"}{ "code": 3, "message": "Invalid input, check schema issues.", "details": []}{ "error": { "message": "Unauthorized", "type": "unauthorized_request_error", "param": null, "code": null }}{ "code": 7, "message": "Not allowed to perform this action for the organization."}{ "code": 13, "message": "This section is not available from a personal account. Use a business organization API key."}{ "code": 8, "message": "Employee with this login is already in the organization."}{ "code": 9, "message": "Employee with this email is already in the organization."}{ "code": 43, "message": "Too many employee creation requests, retry later."}{ "code": 1, "message": "Internal server error.", "trace_id": "66a346f64dcb57627c03d596"}