метод REST scope: crm

crm.requisite.preset.add

Создать шаблон

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

Описание

Метод создает новый шаблон реквизитов.

Параметры

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

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

Параметр fields

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

Идентификатор типа родительского объекта. Сейчас это только «Реквизит» (идентификатор 8).

Идентификаторы типов объектов CRM отдает метод crm.enum.ownertype

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

Идентификатор страны, которой соответствует набор полей шаблона реквизитов (для получения доступных значений смотрите метод crm.requisite.preset.countries)

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

Название шаблона

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

Внешний ключ. Используется для операций обмена. Идентификатор объекта внешней информационной базы.

Назначение поля может меняться конечным разработчиком.

Каждое приложение обеспечивает уникальность значений в этом поле. Рекомендуется использовать уникальный префикс для избежания коллизий с другими приложениями.

В CRM зарезервированы значения вида #CRM_REQUISITE_PRESET_DEF_... для идентификации шаблонов, которые используются по умолчанию. Не следует использовать эти идентификаторы для своих целей, так как это может привести к нарушению логики

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

Признак активности. Используются значения Y или N. Определяет доступность шаблона в списке выбора при добавлении реквизитов

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

Сортировка

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"ENTITY_TYPE_ID":8,"COUNTRY_ID":1,"NAME":"ИП","XML_ID":"EXAMPLE_COMPANY__VALUE_1","ACTIVE":"Y","SORT":520}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.preset.add

Ответ

HTTP-статус: 200

{
    "result": 347,
    "time": {
        "start": 1716543593.35189,
        "finish": 1716543593.683898,
        "duration": 0.33200788497924805,
        "processing": 0.016175031661987305,
        "date_start": "2024-05-24T11:39:53+02:00",
        "date_finish": "2024-05-24T11:39:53+02:00",
        "operating": 0
    }
}

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

result integer

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

time time

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

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

{
    "error": "",
    "error_description": "ENTITY_TYPE_ID is not defined or invalid"
}
Код Описание Значение
ENTITY_TYPE_ID is not defined or invalid Идентификатор типа родительского объекта не определен или имеет недопустимое значение
Access denied Недостаточно прав доступа для добавления шаблона

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

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