метод REST scope: documentgenerator

documentgenerator.region.delete

Удалить регион

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

Описание

Метод documentgenerator.region.delete удаляет пользовательский регион по идентификатору.

Параметры

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

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

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

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

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"id":1}' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/documentgenerator.region.delete

Ответ

HTTP-статус: 200

{
    "result": null,
    "time": {
        "start": 1742906400,
        "finish": 1742906400.201234,
        "duration": 0.2012341022491455,
        "processing": 0,
        "date_start": "2025-03-25T10:00:00+03:00",
        "date_finish": "2025-03-25T10:00:00+03:00",
        "operating_reset_at": 1742907000,
        "operating": 0
    }
}

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

result null

Метод удаляет регион и возвращает null.

Также может вернуть null без ошибок, если в параметре id указан несуществующий регион

time time

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

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

HTTP-статус: 400

{
    "error": "BX_ERROR",
    "error_description": "К этому региону есть привязанные шаблоны"
}
Код Описание Значение
400 BX_ERROR К этому региону есть привязанные шаблоны
400 100 Could not find value for parameter {id}
400 0 You do not have permissions to modify templates

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

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