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

Метод для редактирования сотрудника.

Для редактирования сотрудника вам необходимо знать его id и указать его в URL запроса. Все редактируемые параметры сотрдуника указываются в теле запроса. Получить актуальный список идентификаторов дополнительных полей сотрудника вы можете в методе Список дополнительных полей.

put /users/{id} редактирование сотрудника по указанному идентификатору
Запрос
user object* Собранный объект параметров редактируемого сотрудника
first_name string** Имя
last_name string** Фамилия
nickname string** Имя пользователя
email string** Электронная почта
phone_number string** Телефон
department string** Подразделение
role string** Уровень доступа: admin (администратор), user (сотрудник), multi_guest (мульти-гость)
suspended boolean** Приостановка доступа
list_tags array of strings** Массив тегов, привязываемых к сотруднику
custom_properties array of objects** Задаваемые дополнительные поля
id integer Идентификатор поля
value string Устанавливаемое значение
Ответ
data object Созданный сотрудник
id integer Идентификатор созданного пользователя
first_name string Имя
last_name string Фамилия
nickname string Имя пользователя
email string Электронная почта
phone_number string Телефон
department string Подразделение
role string Уровень доступа: admin (администратор), user (сотрудник), multi_guest (мульти-гость)
suspended boolean Приостановка доступа
invite_status string Статус пришлашения: confirmed (принято), sent (отправлено)
list_tags array of strings Массив тегов, привязанных к сотруднику
custom_properties array of objects Дополнительные поля сотрудника
id integer Идентификатор поля
name string Название поля
data_type string Тип поля (string, number, date или link)
value string Значение
user_status object или null Статус. Возвращается как null, если статус не установлен.
emoji string Emoji символ статуса
title string Текст статуса
expires_at string или null Срок жизни статуса (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ. Возвращается как null, если срок не установлен.
bot boolean Тип: пользователь (false) или бот (true)
created_at string Дата создания (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ
Возможные ошибки запроса (errors code)
blank Обязательное поле (не может быть пустым)
too_long Слишком длинное значение (пояснения вы получите в поле message)
invalid Поле не соответствует правилам (пояснения вы получите в поле message)
licenses_limit Превышен лимит активных сотрудников (пояснения вы получите в поле message)
Идентификатор редактируемого сотрудника передается в URL (например, /users/12)
Остальные параметры указываются в теле запроса
{
  "user": {
    "nickname": "olegpetrov",
    "role": "user",
    "list_tags": [
      "Product"
    ]
  }
}
{
  "data": {
    "id": 12,
    "first_name": "Олег",
    "last_name": "Петров",
    "nickname": "olegpetrov",
    "email": "olegp@example.com",
    "phone_number": "",
    "department": "Продукт",
    "role": "user",
    "suspended": false,
    "invite_status": "confirmed",
    "list_tags": [
      "Product"
    ],
    "custom_properties": [
      {
        "id": 1678,
        "name": "Город",
        "data_type": "string",
        "value": "Санкт-Петербург"
      }
    ],
    "user_status": null,
    "bot": false,
    "created_at": "2023-07-08T09:31:17.000Z"
  }
}