метод REST scope: crm

crm.requisite.preset.field.update

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

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

Описание

Метод изменяет настраиваемое поле в шаблоне реквизитов.

Параметры

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

Идентификатор настраиваемого поля, которое нужно изменить.

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

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

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

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

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

Объект с полями и их значениями, которые нужно изменить. Метод crm.requisite.preset.field.fields позволяет получить описание полей, которые можно менять.

API требует указать значение в поле FIELD_NAME. Если его не нужно менять, то можно указать текущее

Параметр fields

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

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

API требует указать значение в этом поле. Если его не нужно менять, то можно указать текущее

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

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

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

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

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

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

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

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ID":1,"preset":{"ID":27},"fields":{"FIELD_NAME":"RQ_NAME","FIELD_TITLE":"Имя","IN_SHORT_LIST":"Y"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.preset.field.update

Ответ

HTTP-статус: 200

{
    "result": true,
    "time": {
        "start": 1716898310.398361,
        "finish": 1716898310.936332,
        "duration": 0.537971019744873,
        "processing": 0.09376883506774902,
        "date_start": "2024-05-28T14:11:50+02:00",
        "date_finish": "2024-05-28T14:11:50+02:00",
        "operating": 0
    }
}

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

result boolean

Результат изменения настраиваемого поля:
- true — изменено
- false — не изменено

time time

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

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

{
    "error": "",
    "error_description": "The PresetField with ID '27' is not found"
}
Код Описание Значение
The PresetField with ID '1' is not found Поле с указанным идентификатором не найдено
The Preset with ID '27' is not found Шаблон с указанным идентификатором не найден
ID is not defined or invalid Идентификатор поля не указан или имеет недопустимое значение
Access denied Недостаточно прав доступа для удаления поля из шаблона реквизитов

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

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