Создать элемент CRM v 3.0 crm.<тип>.add

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

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

Scope: crm

Кто может выполнять метод: пользователь с правом на добавление элементов этого типа объекта CRM. Для моей компании — администратор CRM

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

Метод crm.<тип>.add создает элемент CRM и возвращает его идентификатор. Тип объекта задает сегмент <тип> в имени метода.

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

Тип объекта

Метод

Поля

Сделка

crm.deal.add

Поля сделки

Лид

crm.lead.add

Поля лида

Контакт

crm.contact.add

Поля контакта

Компания

crm.company.add

Поля компании

Предложение

crm.quote.add

Поля предложения

Счет

crm.smartinvoice.add

Поля счета

Моя компания

crm.mycompany.add

Поля моей компании

Смарт-процесс

crm.smartprocess<entityTypeId>.add, например crm.smartprocess1038.add

Поля смарт-процесса

Для смарт-процесса в имя метода подставляется идентификатор его типа entityTypeId. Идентификаторы типов смарт-процессов возвращает метод crm.type.list в поле entityTypeId.

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

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

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

Название
тип

Описание

fields*
object

Объект с полями нового элемента в формате {"поле": "значение"}. Описание параметра.

У лида, контакта, компании и моей компании есть обязательные поля

Параметр fields

Имена полей пишутся в camelCase: title, assignedById, stageId. Имена в верхнем регистре, например TITLE, метод не принимает и отвечает ошибкой неизвестного поля. Передавайте только поля, которые можно изменять. Состав полей у каждого типа объекта свой, описания полей — на страницах:

Список полей с признаком, можно ли поле изменять, возвращает метод crm.<тип>.field.list.

Пользовательские поля передаются по имени, например UF_CRM_1687529546. Их список возвращает метод crm.<тип>.field.custom.list.

Значение stageId должно быть стадией из воронки элемента, а categoryId — существующей воронкой этого типа объекта. Стадии и воронки можно получить методами crm.<тип>.category.stage.list и crm.<тип>.category.list.

Что метод подставляет, если поле не передано:

  • без categoryId элемент создается в воронке по умолчанию
  • без stageId элемент попадает на первую стадию воронки. Если передан только stageId, он проверяется по стадиям воронки по умолчанию
  • без title у смарт-процесса, предложения и счета название формируется из названия типа и идентификатора, например «Закупки #35» или «Предложение #147»

Товарные позиции через fields не передаются: их добавляют методами crm.<тип>.productrow.* после создания элемента.

Обязательные поля

Без этих полей метод вернет ошибку и элемент не создаст:

Тип объекта

Обязательно

Лид, компания, моя компания

title

Контакт

name или lastName — хотя бы одно из двух

Сделка, предложение, счет, смарт-процесс

Нет обязательных полей. Элемент создается и с пустым объектом fields

Примеры кода

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

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

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

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"title":"Заявка на закупку","assignedById":1,"opportunity":150000,"currencyId":"RUB"}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.smartprocess1038.add

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"title":"Заявка на закупку","assignedById":1,"opportunity":150000,"currencyId":"RUB"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/crm.smartprocess1038.add

Методы 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 ItemAddResult = {
  id: number
}

try {
  const response = await $b24.getHttpClient(ApiVersion.v3).call<ItemAddResult>(
    'crm.smartprocess1038.add',
    {
      fields: {
        title: 'Заявка на закупку',
        assignedById: 1,
        opportunity: 150000,
        currencyId: 'RUB',
      },
    },
    Text.getUuidRfc4122()
  )

  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Item created:', result.id)
  }
} 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 addItem() {
    try {
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.getHttpClient(B24Js.ApiVersion.v3).call(
        'crm.smartprocess1038.add',
        {
          fields: {
            title: 'Заявка на закупку',
            assignedById: 1,
            opportunity: 150000,
            currencyId: 'RUB',
          },
        },
        B24Js.Text.getUuidRfc4122()
      )

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

      const result = response.getData().result
      console.info('Item created:', result.id)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', addItem)
</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.add"
Config().configure(api_v3_methods=Config().api_v3_methods | {method})

try:
    response = bitrix_token.call_method(
        api_method=method,
        params={
            "fields": {
                "title": "Заявка на закупку",
                "assignedById": 1,
                "opportunity": 150000,
                "currencyId": "RUB",
            },
        },
        prefer_version=3,
    )
    result = response["result"]
    print(result)
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.add',
            [
                'fields' => [
                    'title' => 'Заявка на закупку',
                    'assignedById' => 1,
                    'opportunity' => 150000,
                    'currencyId' => 'RUB',
                ],
            ]
        );

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

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

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

BX24.callMethod(
    'crm.smartprocess1038.add',
    {
        fields: {
            title: 'Заявка на закупку',
            assignedById: 1,
            opportunity: 150000,
            currencyId: 'RUB',
        },
    },
    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.add',
    [
        'fields' => [
            'title' => 'Заявка на закупку',
            'assignedById' => 1,
            'opportunity' => 150000,
            'currencyId' => 'RUB',
        ],
    ]
);

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

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.smartprocess1038.add", b24.Params{
	"fields": b24.Params{
		"title":        "Заявка на закупку",
		"assignedById": 1,
		"opportunity":  150000,
		"currencyId":   "RUB",
	},
})
if err != nil {
	return fmt.Errorf("crm.smartprocess1038.add: %w", err)
}

var created struct {
	ID int `json:"id"`
}
if err := json.Unmarshal(res.Result, &created); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(created.ID)

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

HTTP-статус: 200

{
    "result": {
        "id": 7
    },
    "time": {
        "start": 1793705270,
        "finish": 1793705272.058552,
        "duration": 2.0585520267486572,
        "processing": 1,
        "date_start": "2026-11-03T14:27:50+03:00",
        "date_finish": "2026-11-03T14:27:52+03:00",
        "operating_reset_at": 1793705820,
        "operating": 0.8111288547515869
    }
}

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

Название
тип

Описание

result
object

Объект с данными ответа

result.id
integer

Идентификатор созданного элемента. Поля элемента можно получить методом crm.<тип>.get

time
time

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

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

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION",
        "message": "Ошибка при валидации объекта",
        "validation": [
            {
                "message": "Значение поля не содержится в списке допустимых значений: DT1038_69:NEW, DT1038_69:PREPARATION, DT1038_69:CLIENT, DT1038_69:SUCCESS, DT1038_69:FAIL",
                "field": "stageId"
            }
        ]
    }
}

Название
тип

Описание

error.code
string

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

error.message
string

Текстовое описание ошибки

error.validation
array

Массив c деталями ошибки. Присутствует только в ошибках валидации данных BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

error.validation[].field
string

Название поля, в котором возникла ошибка валидации

error.validation[].message
string

Описание ошибки, связанной с указанным полем

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

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

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Поле

Описание ошибки

Как исправить

fields

Обязательное поле fields не указано

Передайте объект fields

assignedById

В поле assignedById требуется тип данных int для такого запроса

Передайте значение того типа, который указан в описании поля

Ошибки валидации объекта

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION

Поле

Описание ошибки

Как исправить

title

Не заполнено обязательное поле "title"

Передайте title в fields. Поле обязательно для лида, компании и моей компании

-

At least one of name or lastName is required.

Передайте name или lastName в fields. Правило действует для контакта

id

Поле "id" не доступно к заполнению

Уберите id из fields: идентификатор назначается автоматически

stageId

Значение поля не содержится в списке допустимых значений: #STAGES#

Передайте стадию из воронки элемента. В тексте ошибки перечислены допустимые стадии

categoryId

Значение поля не содержится в списке допустимых значений

Передайте идентификатор существующей воронки этого типа объекта

Ошибка неизвестного поля

Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Поле

Описание ошибки

Как исправить

-

Неизвестное поле #FIELD# для сущности #DTO#

Проверьте имя поля по странице полей типа объекта. Имена полей пишутся в camelCase: title, а не TITLE. Ошибку с именем поля 0 вызывает fields, переданный строкой или массивом вместо объекта

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

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

Поле

Описание ошибки

Как исправить

-

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

Проверьте имя метода: оно пишется в нижнем регистре, например crm.smartinvoice.add. Для смарт-процесса проверьте 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

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Предыдущая
Обзор методов
Следующая
Изменить элемент