Add Address crm.address.add

Scope: crm

Who can execute the method: any user

This method adds a new address for a requisite or lead. For the user, this address appears as the address of a contact, company, or lead.

Multiple addresses of different types can be created, linked to a single requisite.

Method Parameters

Required parameters are marked with *

Name `type`	Description
fields* `object`	A set of fields — an object of the form `{"field": "value"[, ...]}` for adding the address

Parameter fields

Required parameters are marked with *

Name `type`	Description
TYPE_ID* `integer`	Identifier of the address type. Enumeration element "Address Type". Elements of the enumeration "Address Type" can be obtained using the method crm.enum.addresstype
ENTITY_TYPE_ID* `integer`	Identifier of the parent object's type. Identifiers of object types can be obtained using the method crm.enum.ownertype. Addresses can only be linked to Requisites (and requisites are linked to companies or contacts) or Leads. For backward compatibility, the ability to link Addresses with Contacts or Companies is retained. However, this linkage is only possible on some older accounts where the old address handling mode was specifically enabled by technical support.
ENTITY_ID* `string`	Identifier of the parent object (requisite or lead)
ADDRESS_1 `string`	Street, house, building, structure
ADDRESS_2 `string`	Apartment / office
CITY `string`	City
POSTAL_CODE `string`	Postal code
REGION `string`	District
PROVINCE `string`	State
COUNTRY `string`	Country
COUNTRY_CODE `string`	Country code. Not used, retained for backward compatibility. An empty string can be specified as a value.
LOC_ADDR_ID `integer`	Identifier of the location address. This field contains the identifier of the address object in the `Location` module, linked to the CRM address object. Each CRM address corresponds to an address object in the `location` module. This can be used to copy an existing address in CRM with location information that is not in the CRM address fields. If the identifier of the `location` module address is specified when creating the address, a copy of the `location` address is created and linked to the created CRM address. If no values are specified for the string address fields in this case, they will be filled from the location address. If at least one string field is specified, only the specified fields will be saved in the CRM address, and their values will overwrite the corresponding values in the location address object. The same behavior will occur when updating the address.

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"TYPE_ID":1,"ENTITY_TYPE_ID":8,"ENTITY_ID":1,"ADDRESS_1":"4 Peace Avenue","ADDRESS_2":"Drama Theater","CITY":"City","POSTAL_CODE":"000000","REGION":"Urban District","PROVINCE":"Region","COUNTRY":"USA"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.address.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"TYPE_ID":1,"ENTITY_TYPE_ID":8,"ENTITY_ID":1,"ADDRESS_1":"4 Peace Avenue","ADDRESS_2":"Drama Theater","CITY":"City","POSTAL_CODE":"000000","REGION":"Urban District","PROVINCE":"Region","COUNTRY":"USA"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.address.add

try
        {
        	const response = await $b24.callMethod(
        		"crm.address.add",
        		{
        			fields:
        			{
        				"TYPE_ID": 1,            // Address type, see crm.enum.addresstype
        				"ENTITY_TYPE_ID": 8,     // Object type (requisite or lead)
        				"ENTITY_ID": 1,          // Identifier of the requisite
                        "ADDRESS_1": "4 Peace Avenue",
                        "ADDRESS_2": "Drama Theater",
                        "CITY": "City",
                        "POSTAL_CODE": "00000",
                        "REGION": "Urban District",
                        "PROVINCE": "Region",
                        "COUNTRY": "USA",
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	if(result.error())
        		console.error(result.error());
        }
        catch(error)
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.address.add',
                    [
                        'fields' => [
                            'TYPE_ID'        => 1,
                            'ENTITY_TYPE_ID' => 8,
                            'ENTITY_ID'      => 1,
                            'ADDRESS_1' => '4 Peace Avenue',
                            'ADDRESS_2' => 'Drama Theater',
                            'CITY' => 'City',
                            'POSTAL_CODE' => '00000',
                            'REGION' => 'Urban District',
                            'PROVINCE' => 'Region',
                            'COUNTRY' => 'USA',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding address: ' . $e->getMessage();
        }

BX24.callMethod(
            "crm.address.add",
            {
                fields:
                {
                    "TYPE_ID": 1,            // Address type, see crm.enum.addresstype
                    "ENTITY_TYPE_ID": 8,     // Object type (requisite or lead)
                    "ENTITY_ID": 1,          // Identifier of the requisite
                    "ADDRESS_1": "4 Peace Avenue",
                    "ADDRESS_2": "Drama Theater",
                    "CITY": "City",
                    "POSTAL_CODE": "00000",
                    "REGION": "Urban District",
                    "PROVINCE": "Region",
                    "COUNTRY": "USA",
                }
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.address.add',
            [
                'fields' => [
                    'TYPE_ID' => 1,
                    'ENTITY_TYPE_ID' => 8,
                    'ENTITY_ID' => 1,
                    'ADDRESS_1' => '4 Peace Avenue',
                    'ADDRESS_2' => 'Drama Theater',
                    'CITY' => 'City',
                    'POSTAL_CODE' => '00000',
                    'REGION' => 'Urban District',
                    'PROVINCE' => 'Region',
                    'COUNTRY' => 'USA',
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": true,
            "time": {
                "start": 1712922620.724857,
                "finish": 1712922623.393783,
                "duration": 2.6689260005950928,
                "processing": 2.210068941116333,
                "date_start": "2024-04-12T14:50:20+02:00",
                "date_finish": "2024-04-12T14:50:23+02:00"
            }
        }

Returned Data

Name
type

Description

result
boolean

Result of adding the address:

true — added
false — not added

time
time

Information about the request execution time

Error Handling

HTTP status: 40x, 50x

{
            "error": "",
            "error_description": "ENTITY_ID is not defined or invalid."
        }

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
`TYPE_ID is not defined or invalid`	Address type identifier is not specified or has an invalid value
`ENTITY_TYPE_ID is not defined or invalid`	Parent object type identifier is not specified or has an invalid value.
`ENTITY_ID is not defined or invalid`	Parent object identifier is not specified or has an invalid value
`TypeAddress exists`	An address of this type already exists for the specified parent object
`Access denied`	Insufficient access permissions to add the 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

Overview of methods

Update address of detail

Add Address crm.address.add

Method ParametersMethod Parameters

Parameter fieldsParameter fields

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