Получить обязательность поля v 3.0 crm.<тип>.field.required.get

Выберите инструмент для разработки с AI-агентом:

используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: crm

Кто может выполнять метод: пользователь с правом «Разрешить изменять настройки» в CRM

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.

Метод crm.<тип>.field.required.get возвращает настройку обязательности поля: режим и стадии, на которых поле обязательно. Тип объекта задает сегмент <тип> в имени метода.

Имя метода для типа объекта

Тип объекта	Метод	Поля
Сделка	`crm.deal.field.required.get`	Поля сделки
Лид	`crm.lead.field.required.get`	Поля лида
Контакт	`crm.contact.field.required.get`	Поля контакта
Компания	`crm.company.field.required.get`	Поля компании
Предложение	`crm.quote.field.required.get`	Поля предложения
Счет	`crm.smartinvoice.field.required.get`	Поля счета
Смарт-процесс	`crm.smartprocess<entityTypeId>.field.required.get`, например `crm.smartprocess1038.field.required.get`	Поля смарт-процесса

Для смарт-процесса в имя метода подставляется идентификатор его типа entityTypeId. Идентификаторы типов смарт-процессов возвращает метод crm.type.list в поле entityTypeId. Методы обязательности полей есть у смарт-процесса при любых настройках типа. У моей компании этих методов нет: на crm.mycompany.field.required.get Битрикс24 ответит ошибкой «Метод не найден».

Имя метода пишется в нижнем регистре: crm.smartinvoice.field.required.get, а не crm.smartInvoice.field.required.get. На имя в другом регистре метод отвечает ошибкой «Метод не найден».

Параметры метода

Обязательные параметры отмечены *

Название `тип`	Описание
fieldId* `string`	Имя поля: стандартного в camelCase, например `title` или `opportunity`, или пользовательского, например `UF_CRM_CONTRACT_NUMBER`. Имена полей возвращает метод crm.<тип>.field.list
categoryId `integer`	Идентификатор воронки. Когда передавать

Параметр categoryId

Битрикс24 хранит обязательность отдельно для каждой воронки. Передавать ли categoryId, зависит от типа объекта:

Тип объекта	categoryId
Сделка, контакт, компания	Обязателен. Воронку по умолчанию задает `0`, другие воронки — их идентификаторы из метода crm.<тип>.category.list
Смарт-процесс	Обязателен. Идентификатор воронки из метода crm.<тип>.category.list. Если в типе выключены воронки, методов воронок у смарт-процесса нет: идентификатор единственной воронки возвращает метод crm.category.list с `entityTypeId` смарт-процесса
Счет	Обязателен. Идентификатор воронки счетов возвращает метод crm.category.list с `entityTypeId` = `31`: в REST 3.0 метода воронок счета нет
Лид, предложение	Не передается

Если передать categoryId не по таблице, метод вернет ошибку с текстом Invalid category ID.

Примеры кода

Как использовать примеры в документации

Вызов нового API отличается добавлением параметра /api/ в запросе:

https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/crm.smartprocess1038.field.required.get

Примеры получают обязательность поля «Номер договора» в воронке 69 смарт-процесса с идентификатором типа 1038. Для другого типа объекта замените имя метода по таблице выше.

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fieldId":"UF_CRM_CONTRACT_NUMBER","categoryId":69}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.smartprocess1038.field.required.get

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fieldId":"UF_CRM_CONTRACT_NUMBER","categoryId":69,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/crm.smartprocess1038.field.required.get

Методы CRM пока не входят в список методов REST 3.0, который знает $b24.actions.v3.call.make: такой вызов вернет ошибку SDK JSSDK_CORE_METHOD_NOT_SUPPORT_IN_API_V3. Вызывайте метод через HTTP-клиент REST 3.0 — $b24.getHttpClient(ApiVersion.v3).call.

import { ApiVersion, Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

type RequirementResult = {
  item: {
    fieldId: string
    categoryId: number | null
    mode: 'none' | 'all' | 'stages'
    requiredStageIds: string[]
    globallyRequired: boolean
  }
}

try {
  const response = await $b24.getHttpClient(ApiVersion.v3).call<RequirementResult>(
    'crm.smartprocess1038.field.required.get',
    {
      fieldId: 'UF_CRM_CONTRACT_NUMBER',
      categoryId: 69,
    },
    Text.getUuidRfc4122()
  )

  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info(result.item.mode, result.item.requiredStageIds)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}

Методы CRM пока не входят в список методов REST 3.0, который знает $b24.actions.v3.call.make. Вызывайте метод через HTTP-клиент REST 3.0 — $b24.getHttpClient(B24Js.ApiVersion.v3).call.

<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function getRequirement() {
    try {
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.getHttpClient(B24Js.ApiVersion.v3).call(
        'crm.smartprocess1038.field.required.get',
        {
          fieldId: 'UF_CRM_CONTRACT_NUMBER',
          categoryId: 69,
        },
        B24Js.Text.getUuidRfc4122()
      )

      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info(result.item.mode, result.item.requiredStageIds)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getRequirement)
</script>

У методов CRM нет готовых оберток в b24pysdk, и SDK отправляет в REST 3.0 только методы из списка Config().api_v3_methods. Добавьте метод в этот список и вызовите его через bitrix_token.call_method с prefer_version=3.

from b24pysdk import Config
from b24pysdk.errors import BitrixSDKException
from b24pysdk.errors.v3 import BitrixAPIError

method = "crm.smartprocess1038.field.required.get"
Config().configure(api_v3_methods=Config().api_v3_methods | {method})

try:
    response = bitrix_token.call_method(
        api_method=method,
        params={
            "fieldId": "UF_CRM_CONTRACT_NUMBER",
            "categoryId": 69,
        },
        prefer_version=3,
    )
    result = response["result"]
    print(result["item"]["mode"], result["item"]["requiredStageIds"])
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"code: {error.code}",
        f"message: {error.error.message}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

try {
    $response = $b24Service
        ->core
        ->call(
            'crm.smartprocess1038.field.required.get',
            [
                'fieldId' => 'UF_CRM_CONTRACT_NUMBER',
                'categoryId' => 69,
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    print_r($result);
} catch (Throwable $e) {
    echo $e->getMessage();
}

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

BX24.callMethod(
    'crm.smartprocess1038.field.required.get',
    {
        fieldId: 'UF_CRM_CONTRACT_NUMBER',
        categoryId: 69,
    },
    result => {
        if (result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

require_once('crest.php');

$result = CRest::call(
    'crm.smartprocess1038.field.required.get',
    [
        'fieldId' => 'UF_CRM_CONTRACT_NUMBER',
        'categoryId' => 69,
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.smartprocess1038.field.required.get", b24.Params{
	"fieldId":    "UF_CRM_CONTRACT_NUMBER",
	"categoryId": 69,
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("crm.smartprocess1038.field.required.get: %w", err)
}

var out struct {
	Item struct {
		FieldID          string   `json:"fieldId"`
		Mode             string   `json:"mode"`
		RequiredStageIDs []string `json:"requiredStageIds"`
	} `json:"item"`
}
if err := json.Unmarshal(res.Result, &out); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(out.Item.Mode, out.Item.RequiredStageIDs)

Обработка ответа

HTTP-статус: 200

{
    "result": {
        "item": {
            "fieldId": "UF_CRM_CONTRACT_NUMBER",
            "categoryId": 69,
            "mode": "stages",
            "requiredStageIds": [
                "DT1038_69:CLIENT"
            ],
            "globallyRequired": false
        }
    },
    "time": {
        "start": 1793716021,
        "finish": 1793716021.25784,
        "duration": 0.2578399181365967,
        "processing": 0,
        "date_start": "2026-11-03T17:27:01+03:00",
        "date_finish": "2026-11-03T17:27:01+03:00",
        "operating_reset_at": 1793716620,
        "operating": 0
    }
}

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

Название `тип`	Описание
result `object`	Объект с данными ответа
result.item `object`	Настройка обязательности поля. Поля настройки
time `time`	Информация о времени выполнения запроса

Поля настройки

Название `тип`	Описание
fieldId `string`	Имя поля
categoryId `integer`	Идентификатор воронки. У лида и предложения — `null`
mode `string`	Режим обязательности. Возможные значения: `none` — поле необязательно `all` — поле обязательно на всех стадиях воронки `stages` — поле обязательно на стадиях из `requiredStageIds`
requiredStageIds `string[]`	Стадии, на которых поле обязательно. Массив заполнен только при `mode` = `stages`
globallyRequired `boolean`	Обязательно ли поле во всех воронках независимо от `mode`. У пользовательского поля — `true`, если в его настройках `isMandatory` равен `true`

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

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
        "message": "Ошибка при валидации объекта запроса",
        "validation": [
            {
                "message": "Invalid category ID.",
                "field": "categoryId"
            }
        ]
    }
}

Название `тип`	Описание
error.code `string`	Строковый код ошибки. Используйте для идентификации типа исключения
error.message `string`	Текстовое описание ошибки
error.validation `array`	Массив c деталями ошибки. Присутствует только в ошибках валидации данных `BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION`
error.validation[].field `string`	Название поля, в котором возникла ошибка валидации
error.validation[].message `string`	Описание ошибки, связанной с указанным полем

Возможные коды ошибок

Ошибка «Воронка не найдена» приходит с коротким кодом CONTEXT_NOT_FOUND без префикса BITRIX_REST_V3_. Ее текст и тексты ошибок валидации — на английском языке.

Ошибки валидации запроса

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Поле	Описание ошибки	Как исправить
`fieldId`	fieldId must be a non-empty string.	Передайте имя поля строкой, например `"UF_CRM_CONTRACT_NUMBER"`
`categoryId`	Invalid category ID.	Передайте `categoryId` по таблице параметра
`categoryId`	categoryId must be a non-negative integer.	Передайте идентификатор воронки целым числом не меньше `0`

Поле не найдено

Код ошибки: BITRIX_REST_V3_REALISATION_EXCEPTION_FIELDNOTFOUNDEXCEPTION, HTTP-статус 404

Поле	Описание ошибки	Как исправить
`-`	Поле `#FIELD#` не найдено	Проверьте имя поля методом crm.<тип>.field.list. Имена стандартных полей пишутся в camelCase: `title`, а не `TITLE`

Воронка не найдена

Код ошибки: CONTEXT_NOT_FOUND, HTTP-статус 404

Поле	Описание ошибки	Как исправить
`-`	The field requirement context was not found.	Проверьте `categoryId` по таблице параметра

Ошибка доступа

Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION, HTTP-статус 403

Поле	Описание ошибки	Как исправить
`-`	Доступ запрещен	Вызовите метод от имени пользователя с правом «Разрешить изменять настройки» в CRM

Метод не найден

Код ошибки: BITRIX_REST_V3_EXCEPTION_METHODNOTFOUNDEXCEPTION, HTTP-статус 404

Поле	Описание ошибки	Как исправить
`-`	Метод `#METHOD#` не найден	Проверьте имя метода: оно пишется в нижнем регистре, например `crm.smartinvoice.field.required.get`. Для смарт-процесса проверьте `entityTypeId` методом crm.type.list. У моей компании этих методов нет

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит
`401`	`NO_AUTH_FOUND` Wrong authorization data	В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука
`401`	`INVALID_REQUEST` Https required	Методы вызываются только по протоколу HTTPS
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24
`401`	`ACCESS_DENIED` REST is available only on commercial plans	REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом
`404`	`ERROR_METHOD_NOT_FOUND` Method not found!	Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на `provided by the access token`
`401`	`expired_token` The access token provided has expired	Срок действия access-токена истек
`401`	`user_access_error` The user does not have access to the application	Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям
`403`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Была ли статья полезна?

Удалить вариант поля-списка

Сделать поле обязательным

Получить обязательность поля v 3.0 crm.<тип>.field.required.get

Имя метода для типа объектаИмя метода для типа объекта

Параметры методаПараметры метода

Параметр categoryIdПараметр categoryId

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

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

Поля настройкиПоля настройки

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

Возможные коды ошибокВозможные коды ошибок

Ошибки валидации запросаОшибки валидации запроса

Поле не найденоПоле не найдено

Воронка не найденаВоронка не найдена

Ошибка доступаОшибка доступа

Метод не найденМетод не найден

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение

Была ли статья полезна?

Имя метода для типа объекта

Параметры метода

Параметр categoryId

Примеры кода

Обработка ответа

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

Поля настройки

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

Возможные коды ошибок

Ошибки валидации запроса

Поле не найдено

Воронка не найдена

Ошибка доступа

Метод не найден

Статусы и коды системных ошибок

Продолжите изучение