метод REST scope: user

user.add

Пригласить пользователя

Кто может выполнять: администратор

Описание

Метод user.add приглашает пользователя. Возможно только от имени пользователя с правами приглашения пользователей, как правило администратора. В случае успеха пользователю будет выслано стандартное приглашение на портал. В result возвращается идентификатор нового пользователя.

Если нужно добавить пользователя экстранета, то в полях необходимо передать: EXTRANET: Y и SONET_GROUP_ID: [...]. Если нужно добавить пользователя интранета, то обязательно передается: UF_DEPARTMENT: [...].

Параметры

EMAIL string обязательный

E-mail пользователя

NAME string необязательный

Имя

LAST_NAME string необязательный

Фамилия

SECOND_NAME string необязательный

Отчество

PERSONAL_GENDER string необязательный

Пол

PERSONAL_PROFESSION string необязательный

Профессия

PERSONAL_WWW string необязательный

Домашняя страничка

PERSONAL_BIRTHDAY string необязательный

Дата рождения

PERSONAL_PHOTO array необязательный

Фотография, передавайте массив из имени файла и строки с Bаse64

PERSONAL_ICQ string необязательный

ICQ

PERSONAL_PHONE string необязательный

Личный телефон

PERSONAL_FAX string необязательный

Факс

PERSONAL_MOBILE string необязательный

Личный мобильный

PERSONAL_PAGER string необязательный

Пейджер

PERSONAL_STREET string необязательный

Улица проживания

PERSONAL_CITY string необязательный

Город проживания

PERSONAL_STATE string необязательный

Область / край

PERSONAL_ZIP string необязательный

Почтовый индекс

PERSONAL_COUNTRY string необязательный

Страна

PERSONAL_MAILBOX string необязательный

Почтовый ящик

PERSONAL_NOTES string необязательный

Дополнительные заметки

WORK_PHONE string необязательный

Телефон компании

WORK_COMPANY string необязательный

Компания

WORK_POSITION string необязательный

Должность

WORK_DEPARTMENT string необязательный

Отдел

WORK_WWW string необязательный

Сайт компании

WORK_FAX string необязательный

WORK_FAX

WORK_PAGER string необязательный

WORK_PAGER

WORK_STREET string необязательный

WORK_STREET

WORK_MAILBOX string необязательный

WORK_MAILBOX

WORK_CITY string необязательный

Город работы

WORK_STATE string необязательный

WORK_STATE

WORK_ZIP string необязательный

WORK_ZIP

WORK_COUNTRY string необязательный

WORK_COUNTRY

WORK_PROFILE string необязательный

WORK_PROFILE

WORK_LOGO array необязательный

WORK_LOGO

WORK_NOTES string необязательный

WORK_NOTES

UF_SKYPE_LINK string необязательный

Ссылка на чат в Skype

UF_ZOOM string необязательный

Zoom

UF_DEPARTMENT string необязательный

Подразделения

UF_INTERESTS string необязательный

Интересы

UF_SKILLS string необязательный

Навыки

UF_WEB_SITES string необязательный

Другие сайты

UF_XING string необязательный

Xing

UF_LINKEDIN string необязательный

LinkedIn

UF_FACEBOOK string необязательный

Facebook

UF_TWITTER string необязательный

Twitter

UF_SKYPE string необязательный

Skype

UF_DISTRICT string необязательный

Район

UF_PHONE_INNER string необязательный

Внутренний телефон

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
    "EMAIL": "newuser1@example.com",
    "UF_DEPARTMENT": [1]
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/user.add

Ответ

HTTP-статус: 200

{
    "result":12,
    "time":{
        "start":1721733827.713938,
        "finish":1721733828.286292,
        "duration":0.5723540782928467,
        "processing":0.5508849620819092,
        "date_start":"2024-07-23T11:23:47+00:00",
        "date_finish":"2024-07-23T11:23:48+00:00",
        "operating":0.5508630275726318
    }
}

Возвращаемые данные

result integer

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

time time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
    "error": "ERROR_ARGUMENT",
    "error_description": "wrong_email",
    "argument": ""
}
Код Описание Значение
ERROR_ARGUMENT wrong_email Не передан параметр EMAIL или передан некорректный e-mail
ERROR_ARGUMENT Пользователь с таким email уже существует Попытка зарегистрировать пользователя на e-mail, который уже занят
ERROR_CORE access_denied У пользователя нет прав на вызов метода
ERROR_ARGUMENT user_count_exceeded Превышено количество пользователей
ERROR_GROUPID Не указан код группы Не указан код группы при добавлении пользователя в экстранет
ERROR_NO_GROUP Группа указана неверно Неверно указана группа при добавлении пользователя
ERROR_ARGUMENT no_extranet_field При вызове метода не указано к какой группе должен принадлежать пользователь
ERROR_CORE Ошибка обновления полей пользователя

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.