Users

Новый сотрудник

Заводит сотрудника в пространстве и отправляет ему приглашение на почту. Доступно владельцу пространства и администратору, боту метод недоступен.

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

Вы можете заполнять дополнительные поля сотрудника, которые созданы в вашей компании. Получить актуальный список идентификаторов дополнительных полей сотрудника вы можете в методе [Список дополнительных полей](GET /custom_properties).

Поле list_tags сразу заводит сотрудника в теги, а вместе с тегами — и в чаты, к которым эти теги привязаны. У гостя теги не назначаются вовсе: ответ приходит успешный, а list_tags в нём пустой.

Через параметр chat_ids сотрудника можно сразу добавить в указанные чаты. Чтобы создать гостя, передайте role: "guest" — для этой роли chat_ids обязателен и должен содержать ровно один активный чат, в который у токена есть право добавлять участников. При нарушении правил гостевого доступа возвращается 400 с ошибкой по полю chat_ids.

post/users

Request

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

Request body

skip_email_notifyboolean

Пропуск этапа отправки приглашения сотруднику. Сотруднику не будет отправлено письмо на электронную почту с приглашением создать аккаунт. Полезно при предварительном создании аккаунтов перед входом через SSO.

Example request

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

Response

The request has succeeded and a new resource has been created as a result.

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.