метод REST scope: crm

crm.requisite.preset.field.add

Добавить настраиваемое поле в шаблон реквизитов

Кто может выполнять: пользователь с правом на добавление и контактов, и компаний

Описание

Метод добавляет настраиваемое поле в шаблон реквизитов. С помощью метода crm.requisite.preset.field.availabletoadd можно получить поля, доступные для добавления в шаблон.

Прежде чем добавить пользовательское поле UF_... в шаблон, его нужно создать при помощи метода crm.requisite.userfield.add или убедиться, что оно существует.

Параметры

preset object обязательный

Объект, содержащий значение идентификатора шаблона, в который добавляется настраиваемое поле (например, {"ID": 27}).

Идентификаторы шаблонов можно получить с помощью метода crm.requisite.preset.list

fields object обязательный

Набор полей — объект вида {"поле": "значение"[, ...]} для добавления настраиваемого поля шаблона

Параметр fields

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

Название поля.

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

Альтернативное название поля для реквизита.

Альтернативное название отображается в различных формах для заполнения реквизитов. В зависимости от конкретной формы альтернативное название может использоваться или нет

SORT integer необязательный

Сортировка. Порядок в списке полей шаблона

IN_SHORT_LIST char необязательный

Показывать в кратком списке. Устаревшее поле, сейчас не используется. Оставлено для обратной совместимости. Может принимать значения Y или N

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"preset":{"ID":27},"fields":{"FIELD_NAME":"RQ_NAME","FIELD_TITLE":"TEST","IN_SHORT_LIST":"N","SORT":580}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.preset.field.add

Ответ

HTTP-статус: 200

{
    "result": 3,
    "time": {
        "start": 1716811635.108203,
        "finish": 1716811635.503093,
        "duration": 0.39489006996154785,
        "processing": 0.043524980545043945,
        "date_start": "2024-05-27T14:07:15+02:00",
        "date_finish": "2024-05-27T14:07:15+02:00",
        "operating": 0
    }
}

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

result integer

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

time time

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

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

{
    "error": "",
    "error_description": "The field 'RQ_NAME' can not be added."
}
Код Описание Значение
The field 'RQ_NAME' can not be added Поле не может быть добавлено. Возможно, поле уже есть в шаблоне или же оно не доступно для страны, к которой относится шаблон
The Preset with ID '27' is not found Не найден шаблон с указанным идентификатором
Access denied Недостаточно прав доступа для добавления настаиваемого поля в шаблон реквизитов

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

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