Users

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

Меняет карточку сотрудника: перезаписываются только переданные поля. Идентификаторы дополнительных полей отдаёт [Список дополнительных полей](GET /custom_properties).

Поле list_tags заменяет набор тегов целиком, поэтому присылайте вместе с новым тегом и те, что сохраняются. Снятый тег выводит сотрудника из чатов, куда его привёл этот тег, а имя, которого в пространстве ещё нет, создаёт новый тег вместе с назначением.

suspended: true приостанавливает сотрудника: он теряет доступ, но остаётся в чатах, тегах и задачах, а suspended: false возвращает его обратно. Насовсем убирает сотрудника [Удаление сотрудника](DELETE /users/{id}).

Владельца пространства редактирует только он сам, а его роль меняется лишь на администратора. Перевести обычного сотрудника в гостя нельзя — в обоих случаях ответ 403.

Незнакомое значение роли метод молча пропускает: ответ приходит успешный, а роль остаётся прежней.

put/users/{id}

Request

  • Base URL: https://api.pachca.com/api/shared/v1
  • URL: https://api.pachca.com/api/shared/v1/users/{id}
  • Auth: HTTP bearer

Path parameters

idinteger required
Example:12

Идентификатор пользователя

Request body

Example request

{
  "user": {
    "first_name": "Олег",
    "last_name": "Петров",
    "email": "olegpetrov@example.com",
    "phone_number": "+79001234567",
    "nickname": "olegpetrov",
    "department": "Отдел разработки",
    "title": "Старший разработчик",
    "list_tags": [
      "Product",
      "Design"
    ],
    "custom_properties": [
      {
        "id": 1678,
        "value": "Санкт-Петербург"
      }
    ]
  }
}

Response

The request has succeeded.

Example response

{
  "data": {
    "id": 12,
    "first_name": "Олег",
    "last_name": "Петров",
    "nickname": "olegpetrov",
    "email": "olegp@example.com",
    "phone_number": "+79001234567",
    "department": "Продукт",
    "title": "CIO",
    "inviter_id": 185,
    "list_tags": [
      "Product",
      "Design"
    ],
    "custom_properties": [
      {
        "id": 1678,
        "name": "Город",
        "value": "Санкт-Петербург"
      }
    ],
    "user_status": {
      "emoji": "🎮",
      "title": "Очень занят",
      "expires_at": "2024-04-08T10:00:00.000Z",
      "away_message": {
        "text": "Я в отпуске до 15 апреля. По срочным вопросам обращайтесь к @ivanov."
      }
    },
    "created_at": "2020-06-08T09:32:57.000Z",
    "last_activity_at": "2025-01-20T13:40:07.000Z",
    "time_zone": "Europe/Moscow",
    "image_url": "https://app.pachca.com/users/12/photo.jpg"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.