Для разработчиков

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

POST/users
users:create

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

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

Бесплатное пространство, в том числе на пробном периоде, может отправить за сутки ограниченное число писем: приглашения и письма о смене почты считаются вместе, а предел указан на странице Лимиты. Сверх него метод отвечает 422 с кодом daily_invites_limit и сотрудника не заводит, а остаток и время сброса приходят в payload. С skip_email_notify: true письмо не отправляется и в лимит не идёт.

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

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

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

Аватар сотруднику ставят после создания методом PUTЗагрузка аватара сотрудника.

Тело запроса

application/json
user
object
*
first_name
string
Имя
Пример:Олег
Длина:
<= 255 символов
last_name
string
Фамилия
Пример:Петров
Длина:
<= 255 символов
email
string
*
Электронная почта
Пример:olegp@example.com
Длина:
<= 255 символов
phone_number
string
Телефон
Пример:+79001234567
Длина:
<= 255 символов
nickname
string
Имя пользователя
Пример:olegpetrov
Длина:
<= 255 символов
department
string
Департамент
Пример:Продукт
Длина:
<= 255 символов
title
string
Должность
Пример:CIO
role
string
Уровень доступа
Возможные значения
Пример:user
suspended
boolean
Деактивация пользователя
Пример:false
По умолчанию:
false
list_tags[]
array of strings
Массив названий тегов, привязываемых к сотруднику. Значение, которое не является массивом непустых строк, игнорируется.
Пример:["Product","Design"]
chat_ids[]
array of integers, (int32)
Идентификаторы чатов, в которые сотрудник будет добавлен сразу при создании. Для роли guest параметр обязателен и должен содержать ровно один активный чат.
Пример:[12345]
custom_properties[]
array of objects
Задаваемые дополнительные поля
id
integer, (int32)
*
Идентификатор поля
Пример:1678
value
string
*
Устанавливаемое значение
Пример:Санкт-Петербург
Длина:
<= 768 символов
skip_email_notify
boolean
Пропуск этапа отправки приглашения сотруднику. Сотруднику не будет отправлено письмо на электронную почту с приглашением создать аккаунт. Полезно при предварительном создании аккаунтов перед входом через SSO.
Пример:false
По умолчанию:
false

Ответ

201Created
The request has succeeded and a new resource has been created as a result.
data
object
*
Сотрудник
id
integer, (int32)
*
Идентификатор пользователя
Пример:12
first_name
nullablestring
*
Имя. Возвращается null, пока приглашённый сотрудник не завершил регистрацию (invite_status со значением sent).
Пример:Олег
Длина:
<= 255 символов
last_name
nullablestring
*
Фамилия. Если не заполнена, возвращается null или пустая строка.
Пример:Петров
Длина:
<= 255 символов
nickname
string
*
Имя пользователя
Пример:olegpetrov
Длина:
<= 255 символов
email
nullablestring
*
Электронная почта. В чужой карточке приходит null, если у вызывающего нет права видеть персональные данные: у владельца пространства и администратора оно есть всегда, у сотрудника и бота — только когда в пространстве включён показ персональных данных, у гостя и мульти-гостя — никогда. В своей карточке поле приходит всегда.
Пример:olegp@example.com
Длина:
<= 255 символов
phone_number
nullablestring
*
Телефон. В чужой карточке приходит null, если у вызывающего нет права видеть персональные данные: у владельца пространства и администратора оно есть всегда, у сотрудника и бота — только когда в пространстве включён показ персональных данных, у гостя и мульти-гостя — никогда. В своей карточке поле приходит всегда.
Пример:+79001234567
Длина:
<= 255 символов
department
nullablestring
*
Департамент. Если не указан, возвращается null или пустая строка.
Пример:Продукт
Длина:
<= 255 символов
title
nullablestring
*
Должность. Если не указана, возвращается null или пустая строка.
Пример:CIO
role
string
*
Уровень доступа
Возможные значения
Пример:admin
suspended
boolean
*
Деактивация пользователя
Пример:false
invite_status
string
*
Статус приглашения
Возможные значения
Пример:confirmed
inviter_id
nullableinteger, (int32)
*
Идентификатор сотрудника, который пригласил данного сотрудника. Возвращает null, если сотрудник зарегистрировался самостоятельно или если пригласивший сотрудник был удалён.
Пример:185
list_tags[]
array of strings
*
Массив тегов, привязанных к сотруднику. Мульти-гостю в чужой карточке приходит пустым.
Пример:["Product","Design"]
custom_properties[]
array of objects
*
Дополнительные поля сотрудника
id
integer, (int32)
*
Идентификатор поля
Пример:1678
name
string
*
Название поля
Пример:Город
Длина:
<= 32 символов
data_type
string
*
Тип поля
Возможные значения
Пример:string
value
nullablestring
*
Значение. Возвращается null, если поле не заполнено. Число передаётся строкой, дата — в формате ISO 8601.
Пример:Санкт-Петербург
Длина:
<= 768 символов
user_status
nullableobject
*
Статус. null, если у сотрудника не установлен статус.
emoji
string
*
Emoji символ статуса
Пример:🎮
title
string
*
Текст статуса
Пример:Очень занят
Длина:
<= 50 символов
expires_at
nullablestring, (date-time)
*
Срок жизни статуса (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ. null, если срок не задан — такой статус не сбрасывается автоматически.
Пример:2024-04-08T10:00:00.000Z
is_away
boolean
*
Режим «Нет на месте»
Пример:false
away_message
nullableobject
*
Сообщение при режиме «Нет на месте». Отображается в профиле пользователя, а также при отправке ему личного сообщения или упоминании в чате. null, если текст не задан.
text
string
*
Текст сообщения
Пример:Я в отпуске до 15 апреля. По срочным вопросам обращайтесь к @ivanov.
Длина:
<= 1024 символов
bot
boolean
*
Является ботом
Пример:false
sso
boolean
*
Использует ли пользователь SSO
Пример:false
created_at
string, (date-time)
*
Дата создания (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ
Пример:2020-06-08T09:32:57.000Z
last_activity_at
nullablestring, (date-time)
*
Дата последней активности пользователя (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ. null, если сотрудник ещё ни разу не заходил в Пачку — в этом случае invite_status возвращает sent.
Пример:2025-01-20T13:40:07.000Z
time_zone
nullablestring
*
Часовой пояс пользователя. null, если сотрудник не задал личный часовой пояс — тогда применяется часовой пояс компании.
Пример:Europe/Moscow
Длина:
<= 32 символов
image_url
nullablestring
*
Ссылка на скачивание аватарки пользователя. null, если аватарка не загружена.
Пример:https://app.pachca.com/users/12/photo.jpg
Новый сотрудник
pachca users create \  --first-name=Олег \  --last-name=Петров \  --email=olegp@example.com \  --phone-number=+79001234567 \  --nickname=olegpetrov \  --department=Продукт \  --title=CIO \  --role=user \  --list-tags='["Product","Design"]' \  --chat-ids='[12345]' \  --custom-properties='[{"id":1678,"value":"Санкт-Петербург"}]' \  --json \  --token YOUR_ACCESS_TOKEN
Ответ 201
{  "data": {    "id": 12,    "first_name": "Олег",    "last_name": "Петров",    "nickname": "olegpetrov",    "email": "olegp@example.com",    "phone_number": "+79001234567",    "department": "Продукт",    "title": "CIO",    "role": "admin",    "suspended": false,    "invite_status": "confirmed",    "inviter_id": 185,    "list_tags": [      "Product",      "Design"    ],    "custom_properties": [      {        "id": 1678,        "name": "Город",        "data_type": "string",        "value": "Санкт-Петербург"      }    ],    "user_status": {      "emoji": "🎮",      "title": "Очень занят",      "expires_at": "2024-04-08T10:00:00.000Z",      "is_away": false,      "away_message": {        "text": "Я в отпуске до 15 апреля. По срочным вопросам обращайтесь к @ivanov."      }    },    "bot": false,    "sso": false,    "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"  }}