Удаление сотрудников

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

Удаляет одного или нескольких сотрудников из организации по логину. Каждый сотрудник обрабатывается независимо: ошибка по одному логину не отменяет обработку остальных. В ответе — сколько удалено, сколько с ошибкой и перечень логинов с ошибками (причина по каждому).

Headers

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

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

Параметр	Тип	Описание
`logins`*	`string[]`	Массив логинов сотрудников (от 1 до 25). Для удаления одного сотрудника передайте массив из одного элемента

В ответе: deleted — сколько удалено, failed — сколько с ошибкой, failedLogins — перечень логинов с ошибкой (причина и пояснение по каждому).

Причины ошибок в failedLogins:

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

Параметр	Тип	Описание
`not_found`	`string`	Сотрудника с таким логином нет в организации
`forbidden`	`string`	Нельзя удалить сотрудника с равной или более высокой ролью
`error`	`string`	Непредвиденная ошибка при обработке этого сотрудника

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

curl --request POST \
  --url https://gptunnel.ru/api/v1/employees/deleteEmployees \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "logins": ["ivanov", "petrov"]
}'

import axios from 'axios'

const response = await axios({
  method: 'POST',
  url: 'https://gptunnel.ru/api/v1/employees/deleteEmployees',
  headers: {
    Authorization: 'YOUR_API_KEY',
  },
  data: {
    logins: ['ivanov', 'petrov'],
  },
})

console.log(response.data)

import requests

response = requests.post(
    'https://gptunnel.ru/api/v1/employees/deleteEmployees',
    headers={'Authorization': 'YOUR_API_KEY'},
    json={
        'logins': ['ivanov', 'petrov'],
    },
)

print(response.json())

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

{
  "code": 0,
  "deleted": 1,
  "failed": 1,
  "failedLogins": [
    {
      "login": "petrov@example.com",
      "reason": "not_found",
      "message": "Employee not found in the organization."
    }
  ]
}

{
  "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": "Employee management is not available from a personal account. Use a business organization API key."
}

{
  "code": 1,
  "message": "Internal server error.",
  "trace_id": "66a346f64dcb57627c03d596"
}