Create a New Contact crm.contact.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: any user with "add|import" access permission for contacts

DEPRECATED

The development of this method has been halted. Please use crm.item.add.

The method crm.contact.add creates a new contact.

Method Parameters

Name
type

Description

fields
object

An object in the following format:

{
            field_1: value_1,
            field_2: value_2,
            ...,
            field_n: value_n,
        }

where:

field_n — field name
value_n — field value

The list of available fields is described below.

An incorrect field in fields will be ignored

params
object

An object containing a set of additional parameters.

The structure and possible values are described below

Parameter fields

Name `type`	Description
HONORIFIC `crm_status`	Salutation. The list of available salutation types can be obtained using the method `crm.status.list` with the filter `{ ENTITY_ID: "HONORIFIC" }`. Default — the first available salutation type
NAME `string`	First name
SECOND_NAME `string`	Middle name
LAST_NAME `string`	Last name
PHOTO `file`	Photograph
BIRTHDATE `date`	Date of birth
TYPE_ID `crm_status`	Contact type. The list of available contact types can be obtained using the method `crm.status.list` with the filter `{ ENTITY_ID: "CONTACT_TYPE" }`. Default — the first available contact type
SOURCE_ID `crm_status`	Source. The list of available source types can be obtained using the method `crm.status.list` with the filter `{ ENTITY_ID: "SOURCE" }`. Default — the first available source type
SOURCE_DESCRIPTION `string`	Additional information about the source
POST `string`	Position
COMMENTS `string`	Comment. Supports BB codes
OPENED `boolean`	Is it available to everyone? Possible values: `Y` — yes `N` — no Default is `Y`. The default value can be changed in the CRM settings
EXPORT `boolean`	Is the contact included in the export? Possible values: `Y` — yes `N` — no Default is `Y`
ASSIGNED_BY_ID `user`	Identifier of the user responsible for the item. Default — the identifier of the user calling the method
COMPANY_ID `crm_company`	Identifier of the main company for the contact. The list of companies can be obtained using the method `crm.item.list` with `entityTypeId = 4`
COMPANY_IDS `crm_company[]`	Array of identifiers of companies associated with the contact. The list of companies can be obtained using the method `crm.item.list` with `entityTypeId = 4`
UTM_SOURCE `string`	Advertising system (Google Ads, Microsoft Advertising, etc.)
UTM_MEDIUM `string`	Traffic type. Possible values: `CPC` — ads `CPM` — banners
UTM_CAMPAIGN `string`	Advertising campaign designation
UTM_CONTENT `string`	Campaign content. For example, for contextual ads
UTM_TERM `string`	Campaign search condition. For example, keywords for contextual advertising
TRACE `string`	Information for Sales Intelligence
PHONE `crm_multifield[]`	Phone
EMAIL `crm_multifield[]`	E-mail
WEB `crm_multifield[]`	Website
IM `crm_multifield[]`	Messenger
LINK `crm_multifield[]`	Links. Service field
UF_...	Custom fields. For example, `UF_CRM_25534736`. Depending on the portal settings, contacts may have a set of custom fields of defined types. A custom field can be added to a contact using the method crm.contact.userfield.add
PARENT_ID_...	Relationship fields. If there are smart processes associated with contacts on the portal, there is a field for each such smart process that stores the relationship between that smart process and the contact. The field itself stores the identifier of the element of that smart process. For example, the field `PARENT_ID_153` — relationship with the smart process `entityTypeId=153`. It stores the identifier of the element of that smart process associated with the current contact

Fields for connections with external data sources

If the contact is created by an external system, then:

the field ORIGINATOR_ID stores the string identifier of that system
the field ORIGIN_ID stores the string identifier of the contact in that external system
the field ORIGIN_VERSION stores the version of the contact data in that external system

Name `type`	Description
ORIGINATOR_ID `string`	Identifier of the external system that is the source of data about this contact
ORIGIN_ID `string`	Version of the contact data in the external system. Used to protect data from accidental overwriting by the external system. If the data was imported and not changed in the external system, such data can be edited in CRM without fear that the next export will lead to data overwriting
ORIGIN_VERSION `string`	Original version

Import

The fields are available for filling when the parameter IMPORT = 'Y' is passed in the params parameter.

Name `type`	Description
DATE_CREATE `datetime`	Creation date. Available when `IMPORT = Y` is passed in `params`. Cannot be earlier than the creation date of the last created contact
DATE_MODIFY `datetime`	Modification date. Available when `IMPORT = Y` is passed in `params`
CREATED_BY_ID `user`	Created by. Available when `IMPORT = Y` is passed in `params`
MODIFY_BY_ID `user`	Modified by. Available when `IMPORT = Y` is passed in `params`

Deprecated fields

Address fields in the contact are deprecated and are only used for compatibility mode. To work with the address, use requisites.

Name `type`	Description
ADDRESS `string`	Address
ADDRESS_2 `string`	Second line of the address
ADDRESS_CITY `string`	City
ADDRESS_POSTAL_CODE `string`	Postal code
ADDRESS_REGION `string`	Region
ADDRESS_PROVINCE `string`	Province
ADDRESS_COUNTRY `string`	Country
ADDRESS_COUNTRY_CODE `string`	Country code
ADDRESS_LOC_ADDR_ID `integer`	Location address identifier

Parameter params

Name
type

Description

REGISTER_SONET_EVENT
boolean

Should the event of adding a contact be registered in the live feed? Possible values:

Y — yes
N — no

Default is N

IMPORT
boolean

Is import mode enabled? Possible values:

Y — yes

To pass the value No, you must either not pass the parameter at all or pass the value 0, ''

Default is No

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"FIELDS":{"HONORIFIC":"HNR_RU_1","NAME":"John","SECOND_NAME":"Doe","LAST_NAME":"Smith","PHOTO":{"fileData":"**put_photo_data_here**"},"BIRTHDATE":"11.11.2001","TYPE_ID":"PARTNER","SOURCE_ID":"WEB","SOURCE_DESCRIPTION":"*Additional information about the source*","POST":"Administrator","COMMENTS":"**put_comment_here**","OPENED":"Y","EXPORT":"N","ASSIGNED_BY_ID":6,"COMPANY_ID":12,"COMPANY_IDS":[12,13,15],"UTM_SOURCE":"google","UTM_MEDIUM":"CPC","UTM_CAMPAIGN":"summer_sale","UTM_CONTENT":"header_banner","UTM_TERM":"discount","PHONE":[{"VALUE":"+1333333555","VALUE_TYPE":"WORK"},{"VALUE":"+15599888666","VALUE_TYPE":"HOME"}],"EMAIL":[{"VALUE":"john.smith@example.mailing","VALUE_TYPE":"MAILING"},{"VALUE":"john.smith@example.work","VALUE_TYPE":"WORK"}],"UF_CRM_1720697698689":"Example value of a custom field with type \"String\"","PARENT_ID_1224":12}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.contact.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"FIELDS":{"HONORIFIC":"HNR_RU_1","NAME":"John","SECOND_NAME":"Doe","LAST_NAME":"Smith","PHOTO":{"fileData":"**put_photo_data_here**"},"BIRTHDATE":"11.11.2001","TYPE_ID":"PARTNER","SOURCE_ID":"WEB","SOURCE_DESCRIPTION":"*Additional information about the source*","POST":"Administrator","COMMENTS":"**put_comment_here**","OPENED":"Y","EXPORT":"N","ASSIGNED_BY_ID":6,"COMPANY_ID":12,"COMPANY_IDS":[12,13,15],"UTM_SOURCE":"google","UTM_MEDIUM":"CPC","UTM_CAMPAIGN":"summer_sale","UTM_CONTENT":"header_banner","UTM_TERM":"discount","PHONE":[{"VALUE":"+1333333555","VALUE_TYPE":"WORK"},{"VALUE":"+15599888666","VALUE_TYPE":"HOME"}],"EMAIL":[{"VALUE":"john.smith@example.mailing","VALUE_TYPE":"MAILING"},{"VALUE":"john.smith@example.work","VALUE_TYPE":"WORK"}],"UF_CRM_1720697698689":"Example value of a custom field with type \"String\"","PARENT_ID_1224":12},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.contact.add

// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        try {
          const response = await $b24.actions.v2.call.make<number>({
            method: 'crm.contact.add',
            params: {
              fields: {
                HONORIFIC: 'HNR_RU_1',
                NAME: 'Ivan',
                SECOND_NAME: 'Ivanovich',
                LAST_NAME: 'Ivanov',
                PHOTO: {
                  fileData: document.getElementById('photo'),
                },
                BIRTHDATE: '11.11.2001',
                TYPE_ID: 'PARTNER',
                SOURCE_ID: 'WEB',
                SOURCE_DESCRIPTION: '*Additional source details*',
                POST: 'Administrator',
                COMMENTS: `
                  Example comment inside the contact
        
                  [B]Bold text[/B]
                  [I]Italic[/I]
                  [U]Underlined[/U]
                  [S]Strikethrough[/S]
                  [B][I][U][S]Mix[/S][/U][/I][/B]
        
                  [LIST]
                  [*]List item #1
                  [*]List item #2
                  [*]List item #3
                  [/LIST]
        
                  [LIST=1]
                  [*]Numbered list item #1
                  [*]Numbered list item #2
                  [*]Numbered list item #3
                  [/LIST]
                `,
                OPENED: 'Y',
                EXPORT: 'N',
                ASSIGNED_BY_ID: 6,
                COMPANY_ID: 12,
                COMPANY_IDS: [12, 13, 15],
                UTM_SOURCE: 'yandex',
                UTM_MEDIUM: 'CPC',
                UTM_CAMPAIGN: 'summer_sale',
                UTM_CONTENT: 'header_banner',
                UTM_TERM: 'discount',
                PHONE: [
                  {
                    VALUE: '+49333333555',
                    VALUE_TYPE: 'WORK',
                  },
                  {
                    VALUE: '+35599888666',
                    VALUE_TYPE: 'HOME',
                  },
                ],
                EMAIL: [
                  {
                    VALUE: 'ivanov@example.mailing',
                    VALUE_TYPE: 'MAILING',
                  },
                  {
                    VALUE: 'ivanov@example.work',
                    VALUE_TYPE: 'WORK',
                  },
                ],
                UF_CRM_1720697698689: 'Example value of a custom field of type "String"',
                PARENT_ID_1224: 12,
              },
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Created contact id:', result)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }

<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function addContact() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.contact.add',
                params: {
                  fields: {
                    HONORIFIC: 'HNR_RU_1',
                    NAME: 'Ivan',
                    SECOND_NAME: 'Ivanovich',
                    LAST_NAME: 'Ivanov',
                    PHOTO: {
                      fileData: document.getElementById('photo'),
                    },
                    BIRTHDATE: '11.11.2001',
                    TYPE_ID: 'PARTNER',
                    SOURCE_ID: 'WEB',
                    SOURCE_DESCRIPTION: '*Additional source details*',
                    POST: 'Administrator',
                    COMMENTS: `
                      Example comment inside the contact
        
                      [B]Bold text[/B]
                      [I]Italic[/I]
                      [U]Underlined[/U]
                      [S]Strikethrough[/S]
                      [B][I][U][S]Mix[/S][/U][/I][/B]
        
                      [LIST]
                      [*]List item #1
                      [*]List item #2
                      [*]List item #3
                      [/LIST]
        
                      [LIST=1]
                      [*]Numbered list item #1
                      [*]Numbered list item #2
                      [*]Numbered list item #3
                      [/LIST]
                    `,
                    OPENED: 'Y',
                    EXPORT: 'N',
                    ASSIGNED_BY_ID: 6,
                    COMPANY_ID: 12,
                    COMPANY_IDS: [12, 13, 15],
                    UTM_SOURCE: 'yandex',
                    UTM_MEDIUM: 'CPC',
                    UTM_CAMPAIGN: 'summer_sale',
                    UTM_CONTENT: 'header_banner',
                    UTM_TERM: 'discount',
                    PHONE: [
                      {
                        VALUE: '+49333333555',
                        VALUE_TYPE: 'WORK',
                      },
                      {
                        VALUE: '+35599888666',
                        VALUE_TYPE: 'HOME',
                      },
                    ],
                    EMAIL: [
                      {
                        VALUE: 'ivanov@example.mailing',
                        VALUE_TYPE: 'MAILING',
                      },
                      {
                        VALUE: 'ivanov@example.work',
                        VALUE_TYPE: 'WORK',
                      },
                    ],
                    UF_CRM_1720697698689: 'Example value of a custom field of type "String"',
                    PARENT_ID_1224: 12,
                  },
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Created contact id:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addContact)
        </script>

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.contact.add',
                    [
                        'fields' => [
                            'HONORIFIC' => 'HNR_RU_1',
                            'NAME' => 'John',
                            'SECOND_NAME' => 'Doe',
                            'LAST_NAME' => 'Smith',
                            'PHOTO' => [
                                'fileData' => document.getElementById('photo'),
                            ],
                            'BIRTHDATE' => '11.11.2001',
                            'TYPE_ID' => 'PARTNER',
                            'SOURCE_ID' => 'WEB',
                            'SOURCE_DESCRIPTION' => '*Additional information about the source*',
                            'POST' => 'Administrator',
                            'COMMENTS' => '
                                Example comment within the contact
        
                                [B]Bold text[/B]
                                [I]Italic[/I]
                                [U]Underlined[/U]
                                [S]Strikethrough[/S]
                                [B][I][U][S]Mix[/S][/U][/I][/B]
        
                                [LIST]
                                [*]List item #1
                                [*]List item #2
                                [*]List item #3
                                [/LIST]
        
                                [LIST=1]
                                [*]Numbered list item #1
                                [*]Numbered list item #2
                                [*]Numbered list item #3
                                [/LIST]
                            ',
                            'OPENED' => 'Y',
                            'EXPORT' => 'N',
                            'ASSIGNED_BY_ID' => 6,
                            'COMPANY_ID' => 12,
                            'COMPANY_IDS' => [12, 13, 15],
                            'UTM_SOURCE' => 'google',
                            'UTM_MEDIUM' => 'CPC',
                            'UTM_CAMPAIGN' => 'summer_sale',
                            'UTM_CONTENT' => 'header_banner',
                            'UTM_TERM' => 'discount',
                            'PHONE' => [
                                [
                                    'VALUE' => '+1333333555',
                                    'VALUE_TYPE' => 'WORK',
                                ],
                                [
                                    'VALUE' => '+15599888666',
                                    'VALUE_TYPE' => 'HOME',
                                ]
                            ],
                            'EMAIL' => [
                                [
                                    'VALUE' => 'john.smith@example.mailing',
                                    'VALUE_TYPE' => 'MAILING',
                                ],
                                [
                                    'VALUE' => 'john.smith@example.work',
                                    'VALUE_TYPE' => 'WORK',
                                ]
                            ],
                            'UF_CRM_1720697698689' => 'Example value of a custom field with type "String"',
                            'PARENT_ID_1224' => 12,
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding contact: ' . $e->getMessage();
        }

BX24.callMethod(
            'crm.contact.add',
            {
                fields: {
                    HONORIFIC: "HNR_RU_1",
                    NAME: "John",
                    SECOND_NAME: "Doe",
                    LAST_NAME: "Smith",
                    PHOTO: {
                        fileData: document.getElementById('photo'),
                    },
                    BIRTHDATE: '11.11.2001',
                    TYPE_ID: "PARTNER",
                    SOURCE_ID: "WEB",
                    SOURCE_DESCRIPTION: "*Additional information about the source*",
                    POST: "Administrator",
                    COMMENTS: `
                        Example comment within the contact
        
                        [B]Bold text[/B]
                        [I]Italic[/I]
                        [U]Underlined[/U]
                        [S]Strikethrough[/S]
                        [B][I][U][S]Mix[/S][/U][/I][/B]
        
                        [LIST]
                        [*]List item #1
                        [*]List item #2
                        [*]List item #3
                        [/LIST]
        
                        [LIST=1]
                        [*]Numbered list item #1
                        [*]Numbered list item #2
                        [*]Numbered list item #3
                        [/LIST]
                    `,
                    OPENED: "Y",
                    EXPORT: "N",
                    ASSIGNED_BY_ID: 6,
                    COMPANY_ID: 12,
                    COMPANY_IDS: [12, 13, 15],
                    UTM_SOURCE: "google",
                    UTM_MEDIUM: "CPC",
                    UTM_CAMPAIGN: "summer_sale",
                    UTM_CONTENT: "header_banner",
                    UTM_TERM: "discount",
                    PHONE: [
                        {
                            VALUE: "+1333333555",
                            VALUE_TYPE: "WORK",
                        },
                        {
                            VALUE: "+15599888666",
                            VALUE_TYPE: "HOME",
                        }
                    ],
                    EMAIL: [
                        {
                            VALUE: "john.smith@example.mailing",
                            VALUE_TYPE: "MAILING",
                        },
                        {
                            VALUE: "john.smith@example.work",
                            VALUE_TYPE: "WORK",
                        }
                    ],
                    UF_CRM_1720697698689: "Example value of a custom field with type \"String\"",
                    PARENT_ID_1224: 12,
                },
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.contact.add',
            [
                'fields' => [
                    'HONORIFIC' => 'HNR_RU_1',
                    'NAME' => 'John',
                    'SECOND_NAME' => 'Doe',
                    'LAST_NAME' => 'Smith',
                    'PHOTO' => [
                        'fileData' => document.getElementById('photo'),
                    ],
                    'BIRTHDATE' => '11.11.2001',
                    'TYPE_ID' => 'PARTNER',
                    'SOURCE_ID' => 'WEB',
                    'SOURCE_DESCRIPTION' => '*Additional information about the source*',
                    'POST' => 'Administrator',
                    'COMMENTS' => '
                        Example comment within the contact
        
                        [B]Bold text[/B]
                        [I]Italic[/I]
                        [U]Underlined[/U]
                        [S]Strikethrough[/S]
                        [B][I][U][S]Mix[/S][/U][/I][/B]
        
                        [LIST]
                        [*]List item #1
                        [*]List item #2
                        [*]List item #3
                        [/LIST]
        
                        [LIST=1]
                        [*]Numbered list item #1
                        [*]Numbered list item #2
                        [*]Numbered list item #3
                        [/LIST]
                    ',
                    'OPENED' => 'Y',
                    'EXPORT' => 'N',
                    'ASSIGNED_BY_ID' => 6,
                    'COMPANY_ID' => 12,
                    'COMPANY_IDS' => [12, 13, 15],
                    'UTM_SOURCE' => 'google',
                    'UTM_MEDIUM' => 'CPC',
                    'UTM_CAMPAIGN' => 'summer_sale',
                    'UTM_CONTENT' => 'header_banner',
                    'UTM_TERM' => 'discount',
                    'PHONE' => [
                        [
                            'VALUE' => '+1333333555',
                            'VALUE_TYPE' => 'WORK',
                        ],
                        [
                            'VALUE' => '+15599888666',
                            'VALUE_TYPE' => 'HOME',
                        ]
                    ],
                    'EMAIL' => [
                        [
                            'VALUE' => 'john.smith@example.mailing',
                            'VALUE_TYPE' => 'MAILING',
                        ],
                        [
                            'VALUE' => 'john.smith@example.work',
                            'VALUE_TYPE' => 'WORK',
                        ]
                    ],
                    'UF_CRM_1720697698689' => 'Example value of a custom field with type "String"',
                    'PARENT_ID_1224' => 12,
                ]
            ]
        );
        
        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.contact.add", b24.Params{
        	"fields": b24.Params{
        		"HONORIFIC":   "HNR_RU_1",
        		"NAME":        "John",
        		"SECOND_NAME": "Doe",
        		"LAST_NAME":   "Smith",
        		"PHOTO": b24.Params{
        			"fileData": "**put_photo_data_here**",
        		},
        		"BIRTHDATE":          "11.11.2001",
        		"TYPE_ID":            "PARTNER",
        		"SOURCE_ID":          "WEB",
        		"SOURCE_DESCRIPTION": "*Additional information about the source*",
        		"POST":               "Administrator",
        		"COMMENTS":           "**put_comment_here**",
        		"OPENED":             "Y",
        		"EXPORT":             "N",
        		"ASSIGNED_BY_ID":     6,
        		"COMPANY_ID":         12,
        		"COMPANY_IDS":        []int{12, 13, 15},
        		"UTM_SOURCE":         "yandex",
        		"UTM_MEDIUM":         "CPC",
        		"UTM_CAMPAIGN":       "summer_sale",
        		"UTM_CONTENT":        "header_banner",
        		"UTM_TERM":           "discount",
        		"PHONE": []b24.Params{
        			{
        				"VALUE":      "+49333333555",
        				"VALUE_TYPE": "WORK",
        			},
        			{
        				"VALUE":      "+35599888666",
        				"VALUE_TYPE": "HOME",
        			},
        		},
        		"EMAIL": []b24.Params{
        			{
        				"VALUE":      "ivanov@example.mailing",
        				"VALUE_TYPE": "MAILING",
        			},
        			{
        				"VALUE":      "ivanov@example.work",
        				"VALUE_TYPE": "WORK",
        			},
        		},
        		"UF_CRM_1720697698689": "Example value of a custom field with type \"String\"",
        		"PARENT_ID_1224":       12,
        	},
        })
        if err != nil {
        	return fmt.Errorf("crm.contact.add: %w", err)
        }
        
        var newID b24.ID
        if err := json.Unmarshal(res.Result, &newID); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println("id:", newID)

Response Handling

HTTP status: 200

{
            "result": 46,
            "time": {
                "start": 1723713732.235658,
                "finish": 1723713733.742049,
                "duration": 1.5063910484313965,
                "processing": 1.1416668891906738,
                "date_start": "2024-08-15T11:22:12+02:00",
                "date_finish": "2024-08-15T11:22:13+02:00"
            }
        }

Returned Data

Name `type`	Description
result `integer`	The root element of the response, contains the identifier of the created contact
time `time`	Information about the request execution time

Error Handling

HTTP status: 400

{
            "error": "",
            "error_description": "Parameter 'fields' must be array."
        }

Name `type`	Description
error `string`	String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only `error_description` shows the reason
error_description `string`	Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Code	Description	Value
Empty value	`Parameter 'fields' must be array`	The parameter `fields` is not an object
Empty value	`Parameter 'params' must be array`	The parameter `params` is not an object
Empty value	`Access denied`	The user does not have permission to "Add" or "Import" contacts
Empty value	Disk resource exhausted
`ERROR_CORE`	The field `Work e-mail` contains an invalid address

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

Was the article helpful?

Overview of methods

Update contact

Create a New Contact crm.contact.add

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Parameter paramsParameter params

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning