Update Contact crm.contact.update

Scope: crm

Who can execute the method: any user with "edit" access permission for contacts

Method Development Stopped

The method crm.contact.update continues to function, but there is a more relevant alternative crm.item.update.

The method crm.contact.update updates an existing contact.

It is recommended to pass the complete set of address fields when updating the address.

Method Parameters

Required parameters are marked with *

Name `type`	Description
id* `integer`	Identifier of the contact to be changed. The identifier can be obtained using the methods `crm.contact.list` or `crm.contact.add`
fields* `object`	Object in the format: `{ field_1: value_1, field_2: value_2, ..., field_n: value_n, }` where: `field_n` — field name `value_n` — new field value The list of available fields is described below. An incorrect field in `fields` will be ignored. Only those fields that need to be changed should be passed in `fields`
params `object`	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 `crm.status.list` with the filter `{ ENTITY_ID: "HONORIFIC" }`
NAME `string`	First name
SECOND_NAME `string`	Middle name
LAST_NAME `string`	Last name
PHOTO `file`	Photo
BIRTHDATE `date`	Date of birth
TYPE_ID `crm_status`	Contact type. The list of available contact types can be obtained using `crm.status.list` with the filter `{ ENTITY_ID: "CONTACT_TYPE" }`
SOURCE_ID `crm_status`	Source The list of available source types can be obtained using `crm.status.list` with the filter `{ ENTITY_ID: "SOURCE" }`
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
EXPORT `boolean`	Is the contact participating in the export? Possible values: `Y` — yes `N` — no
ASSIGNED_BY_ID `user`	Identifier of the user responsible for the item
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 to which the contact is linked. The list of companies can be obtained using the method `crm.item.list` with `entityTypeId = 4`
UTM_SOURCE `string`	Advertising system (Google Ads, etc.)
UTM_MEDIUM `string`	Type of traffic. Possible values: `CPC` — ads `CPM` — banners
UTM_CAMPAIGN `string`	Advertising campaign designation
UTM_CONTENT `string`	Content of the campaign. For example, for contextual ads
UTM_TERM `string`	Search condition of the campaign. For example, keywords for contextual advertising
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 account settings, contacts may have a set of custom fields of specific types. To change file fields, it is recommended to use the method crm.item.update. 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 related to contacts in the account, there is a field for each such smart process that stores the relationship between this 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 this smart process related to the current contact

Fields for external data sources

If the contact was 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, then such data can be edited in CRM without fear that the next export will lead to data overwriting
ORIGIN_VERSION `string`	Version of the original

Deprecated fields

Address fields in the contact are deprecated and are only used in 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`	Identifier of the location address

Parameter params

Name
type

Description

REGISTER_SONET_EVENT
boolean

Should the update event of the contact be registered in the activity stream? Possible values:

Y — yes
N — no

Default is N

REGISTER_HISTORY_EVENT
boolean

Should the update of the contact be registered in the history? Possible values:

Y — yes
N — no

Default is Y

Code Examples

How to Use Examples in Documentation

Update contact with id = 43

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"ID":43,"FIELDS":{"NAME":"John","BIRTHDATE":"11.11.1999","TYPE_ID":"RECOMMENDATION","SOURCE_ID":"WEB","POST":"Network Administrator","COMMENTS":"New comment","OPENED":"N","EXPORT":"Y","ASSIGNED_BY_ID":1,"COMPANY_ID":12,"COMPANY_IDS":[13,15],"UF_CRM_1720697698689":"Example of a new value for a custom field of type \"String\"","PARENT_ID_1224":14},"PARAMS":{"REGISTER_SONET_EVENT":"N","REGISTER_HISTORY_EVENT":"N"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.contact.update

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"ID":43,"FIELDS":{"NAME":"John","BIRTHDATE":"11.11.1999","TYPE_ID":"RECOMMENDATION","SOURCE_ID":"WEB","POST":"Network Administrator","COMMENTS":"New comment","OPENED":"N","EXPORT":"Y","ASSIGNED_BY_ID":1,"COMPANY_ID":12,"COMPANY_IDS":[13,15],"UF_CRM_1720697698689":"Example of a new value for a custom field of type \"String\"","PARENT_ID_1224":14},"PARAMS":{"REGISTER_SONET_EVENT":"N","REGISTER_HISTORY_EVENT":"N"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.contact.update

try
        {
        	const response = await $b24.callMethod(
        		'crm.contact.update',
        		{
        			id: 43,
        			fields: {
        				NAME: "John",
        				BIRTHDATE: '11.11.1999',
        				TYPE_ID: "RECOMMENDATION",
        				SOURCE_ID: "WEB",
        				POST: "Network Administrator",
        				COMMENTS: "New comment",
        				OPENED: "N",
        				EXPORT: "Y",
        				ASSIGNED_BY_ID: 1,
        				COMPANY_ID: 12,
        				COMPANY_IDS: [13, 15],
        				UF_CRM_1720697698689: "Example of a new value for a custom field of type \"String\"",
        				PARENT_ID_1224: 14,
        			},
        			params: {
        				REGISTER_SONET_EVENT: "N",
        				REGISTER_HISTORY_EVENT: "N",
        			},
        		}
        	);
        	
        	const result = response.getData().result;
        	result.error()
        		? console.error(result.error())
        		: console.info(result)
        	;
        }
        catch( error )
        {
        	console.error('Error:', error);
        }

try {
            $contactId = 123; // Example contact ID
            $fields = [
                'NAME' => 'John',
                'LAST_NAME' => 'Doe',
                'BIRTHDATE' => (new DateTime('1990-01-01'))->format(DateTime::ATOM),
                'PHONE' => '123456789',
                'EMAIL' => 'john.doe@example.com',
                'ADDRESS' => '123 Main St',
                'ADDRESS_CITY' => 'Anytown',
                'ADDRESS_COUNTRY' => 'USA',
            ];
            $params = [
                'REGISTER_SONET_EVENT' => 'Y',
            ];
            $result = $serviceBuilder
                ->getCRMScope()
                ->contact()
                ->update($contactId, $fields, $params);
            if ($result->isSuccess()) {
                print($result->getCoreResponse()->getResponseData()->getResult()[0]);
            } else {
                print('Update failed.');
            }
        } catch (Throwable $e) {
            print('Error: ' . $e->getMessage());
        }

BX24.callMethod(
            'crm.contact.update',
            {
                id: 43,
                fields: {
                    NAME: "John",
                    BIRTHDATE: '11.11.1999',
                    TYPE_ID: "RECOMMENDATION",
                    SOURCE_ID: "WEB",
                    POST: "Network Administrator",
                    COMMENTS: "New comment",
                    OPENED: "N",
                    EXPORT: "Y",
                    ASSIGNED_BY_ID: 1,
                    COMPANY_ID: 12,
                    COMPANY_IDS: [13, 15],
                    UF_CRM_1720697698689: "Example of a new value for a custom field of type \"String\"",
                    PARENT_ID_1224: 14,
                },
                params: {
                    REGISTER_SONET_EVENT: "N",
                    REGISTER_HISTORY_EVENT: "N",
                },
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.contact.update',
            [
                'ID' => 43,
                'FIELDS' => [
                    'NAME' => 'John',
                    'BIRTHDATE' => '11.11.1999',
                    'TYPE_ID' => 'RECOMMENDATION',
                    'SOURCE_ID' => 'WEB',
                    'POST' => 'Network Administrator',
                    'COMMENTS' => 'New comment',
                    'OPENED' => 'N',
                    'EXPORT' => 'Y',
                    'ASSIGNED_BY_ID' => 1,
                    'COMPANY_ID' => 12,
                    'COMPANY_IDS' => [13, 15],
                    'UF_CRM_1720697698689' => 'Example of a new value for a custom field of type "String"',
                    'PARENT_ID_1224' => 14,
                ],
                'PARAMS' => [
                    'REGISTER_SONET_EVENT' => 'N',
                    'REGISTER_HISTORY_EVENT' => 'N',
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Working with Multiple Fields

Update a Multiple Field

To overwrite an existing value of a multiple field, pass the ID of the field you want to change and its new value/type.

Suppose there are the following values for the PHONE field:

[
            {
                "ID": "222",
                "VALUE_TYPE": "WORK",
                "VALUE": "111111",
                "TYPE_ID": "PHONE"
            },
            {
                "ID": "223",
                "VALUE_TYPE": "WORK",
                "VALUE": "222222",
                "TYPE_ID": "PHONE"
            },
            {
                "ID": "224",
                "VALUE_TYPE": "WORK",
                "VALUE": "333333",
                "TYPE_ID": "PHONE"
            }
        ]

To change the value of the phone with ID = 223, pass the following fields parameter:

{
            "fields": {
                "PHONE": [
                    {
                        "ID": 223,
                        "VALUE": "444444",
                        "VALUE_TYPE": "MOBILE"
                    }
                ]
            }
        }

Delete a Single Value from a Multiple Field

To delete one of the values from a multiple field, pass their identifiers and either the parameter DELETE = 'Y' or an empty VALUE.

Suppose there are the following values for the PHONE field:

[
            {
                "ID": "222",
                "VALUE_TYPE": "WORK",
                "VALUE": "111111",
                "TYPE_ID": "PHONE"
            },
            {
                "ID": "223",
                "VALUE_TYPE": "WORK",
                "VALUE": "222222",
                "TYPE_ID": "PHONE"
            },
            {
                "ID": "224",
                "VALUE_TYPE": "WORK",
                "VALUE": "333333",
                "TYPE_ID": "PHONE"
            },
            {
              "ID": "225",
              "VALUE_TYPE": "WORK",
              "VALUE": "44444",
              "TYPE_ID": "PHONE"
            }
        ]

Let's consider ways to delete all values except for the phone with ID = 225:

{
            "fields": {
                "PHONE": [
                    {
                        "ID": 222,
                        "DELETE": "Y"
                    },
                    {
                        "ID": 223,
                        "VALUE": ""
                    },
                    {
                        "ID": 224
                    }
                ]
            }
        }

As a result, the following will remain:

[
            {
                "ID": "225",
                "VALUE_TYPE": "WORK",
                "VALUE": "44444",
                "TYPE_ID": "PHONE"
            }
        ]

Add a New Value to a Multiple Field

To add a new value, simply enter it. Existing values will not be changed.

Example of adding a new value 55555:

{
            "fields": {
                "PHONE": [
                    {
                        "VALUE": "55555",
                        "VALUE_TYPE": "WORK"
                    }
                ]
            }
        }

Response Handling

HTTP status: 200

{
            "result": true,
            "time": {
                "start": 1723820393.459406,
                "finish": 1723820396.129949,
                "duration": 2.6705431938171387,
                "processing": 2.1193439960479736,
                "date_start": "2024-08-16T16:59:53+02:00",
                "date_finish": "2024-08-16T16:59:56+02:00"
            }
        }

Returned Data

Name `type`	Description
result `boolean`	Root element of the response, `true` in case of success
time `time`	Information about the execution time of the request

Error Handling

HTTP status: 400

{
            "error": "",
            "error_description": "Contact is not found"
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

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

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Create new contact

Get contact by Id

Update Contact crm.contact.update

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Parameter paramsParameter params

Code ExamplesCode Examples

Working with Multiple FieldsWorking with Multiple Fields

Update a Multiple FieldUpdate a Multiple Field

Delete a Single Value from a Multiple FieldDelete a Single Value from a Multiple Field

Add a New Value to a Multiple FieldAdd a New Value to a Multiple Field

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