Create a CRM Item v 3.0 crm.[type].add

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: crm

Who can execute the method: a user with permission to add items of this CRM object type. For my company, a CRM administrator

This method belongs to REST 3.0. The call specifics and response format of the new API version are described in the REST 3.0 overview.

The crm.<type>.add method creates a CRM item and returns its ID. The object type is set by the <type> segment of the method name.

Method Name for the Object Type

Object type

Method

Fields

Deal

crm.deal.add

Deal fields

Lead

crm.lead.add

Lead fields

Contact

crm.contact.add

Contact fields

Company

crm.company.add

Company fields

Estimate

crm.quote.add

Estimate fields

Invoice

crm.smartinvoice.add

Invoice fields

My company

crm.mycompany.add

My company fields

SPA

crm.smartprocess<entityTypeId>.add, for example, crm.smartprocess1038.add

SPA fields

For an SPA, the method name includes the type ID entityTypeId. SPA type IDs are returned by the crm.type.list method in the entityTypeId field.

The method name is written in lowercase: crm.smartinvoice.add, not crm.smartInvoice.add. If the name is written in a different case, the method returns the "Method Not Found" error.

Method Parameters

Required parameters are marked with *

Name
type

Description

fields*
object

Object with the fields of the new item in the format {"field": "value"}. Parameter description.

Leads, contacts, companies, and my companies have required fields

The fields Parameter

Field names are written in camelCase: title, assignedById, stageId. The method does not accept uppercase names such as TITLE and returns an unknown field error. Pass only fields that can be edited. Each object type has its own set of fields, which are described on these pages:

The list of fields, with an indication of whether each field can be edited, is returned by the crm.<type>.field.list method.

Custom fields are passed by name, for example, UF_CRM_1687529546. Their list is returned by the crm.<type>.field.custom.list method.

The stageId value must be a stage of the item's pipeline, and categoryId must be an existing pipeline of this object type. Retrieve stages and pipelines with the crm.<type>.category.stage.list and crm.<type>.category.list methods.

What the method sets if a field is not passed:

  • without categoryId, the item is created in the default pipeline
  • without stageId, the item is placed at the first stage of the pipeline. If only stageId is passed, it is validated against the stages of the default pipeline
  • without title, the name of an SPA item, estimate, or invoice is generated from the type name and the ID, for example, "Purchases #35" or "Estimate #147"

Product rows are not passed in fields: add them with the crm.<type>.productrow.* methods after the item is created.

Required Fields

Without these fields, the method returns an error and does not create the item:

Object type

Required

Lead, company, my company

title

Contact

name or lastName — at least one of the two

Deal, estimate, invoice, SPA

No required fields. The item is created even with an empty fields object

Code Examples

How to Use Examples in Documentation

The new API call differs by adding the /api/ segment to the request URL:

https://{installation_address}/rest/api/{user_id}/{webhook_token}/crm.smartprocess1038.add

The examples create an SPA item with the type ID 1038. For a different object type, replace the method name according to the table above.

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"title":"Purchase request","assignedById":1,"opportunity":150000,"currencyId":"EUR"}}' \
        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":"Purchase request","assignedById":1,"opportunity":150000,"currencyId":"EUR"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/crm.smartprocess1038.add
        

CRM methods are not yet included in the list of REST 3.0 methods known to $b24.actions.v3.call.make: such a call returns the SDK error JSSDK_CORE_METHOD_NOT_SUPPORT_IN_API_V3. Call the method through the REST 3.0 HTTP client — $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: 'Purchase request',
                assignedById: 1,
                opportunity: 150000,
                currencyId: 'EUR',
              },
            },
            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 methods are not yet included in the list of REST 3.0 methods known to $b24.actions.v3.call.make. Call the method through the REST 3.0 HTTP client — $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: 'Purchase request',
                    assignedById: 1,
                    opportunity: 150000,
                    currencyId: 'EUR',
                  },
                },
                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>
        

b24pysdk has no ready-made wrappers for CRM methods, and the SDK sends to REST 3.0 only the methods from the Config().api_v3_methods list. Add the method to this list and call it via bitrix_token.call_method with 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": "Purchase request",
                        "assignedById": 1,
                        "opportunity": 150000,
                        "currencyId": "EUR",
                    },
                },
                prefer_version=3,
            )
            result = response["result"]
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"code: {error.code}",
                f"message: {error.error.message}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.smartprocess1038.add',
                    [
                        'fields' => [
                            'title' => 'Purchase request',
                            'assignedById' => 1,
                            'opportunity' => 150000,
                            'currencyId' => 'EUR',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }
        

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.

BX24.callMethod(
            'crm.smartprocess1038.add',
            {
                fields: {
                    title: 'Purchase request',
                    assignedById: 1,
                    opportunity: 150000,
                    currencyId: 'EUR',
                },
            },
            result => {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.

require_once('crest.php');
        
        $result = CRest::call(
            'crm.smartprocess1038.add',
            [
                'fields' => [
                    'title' => 'Purchase request',
                    'assignedById' => 1,
                    'opportunity' => 150000,
                    'currencyId' => 'EUR',
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "crm.smartprocess1038.add", b24.Params{
        	"fields": b24.Params{
        		"title":        "Purchase request",
        		"assignedById": 1,
        		"opportunity":  150000,
        		"currencyId":   "EUR",
        	},
        })
        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("parse response: %w", err)
        }
        fmt.Println(created.ID)
        

Response Handling

HTTP status: 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
            }
        }
        

Returned Data

Name
type

Description

result
object

Object with response data

result.id
integer

ID of the created item. The item fields can be retrieved with the crm.<type>.get method

time
time

Information about the request execution time

Error Handling

HTTP status: 400

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION",
                "message": "Error validating object.",
                "validation": [
                    {
                        "message": "Field value is not one of the possible values: DT1038_69:NEW, DT1038_69:PREPARATION, DT1038_69:CLIENT, DT1038_69:SUCCESS, DT1038_69:FAIL",
                        "field": "stageId"
                    }
                ]
            }
        }
        

Name
type

Description

error.code
string

String error code. Use it to identify the type of exception

error.message
string

Text description of the error

error.validation
array

Array with error details. Present only in data validation errors BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

error.validation[].field
string

Name of the field where the validation error occurred

error.validation[].message
string

Description of the error related to the specified field

Possible Error Codes

Request Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Field

Error description

How to Fix

fields

Required field fields is missing

Pass the fields object

assignedById

This request requires data type int in field assignedById

Pass a value of the type specified in the field description

Object Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION

Field

Error description

How to Fix

title

Required field title is empty

Pass title in fields. The field is required for leads, companies, and my companies

-

At least one of name or lastName is required

Pass name or lastName in fields. The rule applies to contacts

id

Field id is read-only

Remove id from fields: the ID is assigned automatically

stageId

Field value is not one of the possible values: #STAGES#

Pass a stage from the item's pipeline. The error message lists the allowed stages

categoryId

Field value is not one of the possible values

Pass the ID of an existing pipeline of this object type

Unknown Field Error

Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Field

Error description

How to Fix

-

Unknown field #FIELD# found in entity #DTO#

Check the field name on the fields page of the object type. Field names are written in camelCase: title, not TITLE. An error with the field name 0 occurs when fields is passed as a string or an array instead of an object

Method Not Found

Error Code: BITRIX_REST_V3_EXCEPTION_METHODNOTFOUNDEXCEPTION, HTTP status: 404

Field

Error description

How to Fix

-

Method #METHOD# was not found

Check the method name: it is written in lowercase, for example, crm.smartinvoice.add. For an SPA, check entityTypeId with the crm.type.list method

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning