CRM Company Details Addresses: Methods Overview

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Addresses store postal and legal data associated with company details, leads, and, for backward compatibility, contacts or companies on older portals.

Quick navigation: All Methods

User documentation: How to Add Your Company's Company Details

Getting Started

  1. Determine the parent object type ENTITY_TYPE_ID
  2. Retrieve the parent object identifier ENTITY_ID
  3. Create an address using the crm.address.add method
  4. Update an address using the crm.address.update method
  5. Retrieve a list of addresses by filter using the crm.address.list method
  6. If an address is no longer needed, delete it using the crm.address.delete method

Address Identifiers

  • TYPE_ID — the address type, such as legal or physical. Values can be retrieved using the crm.enum.addresstype method
  • ENTITY_TYPE_ID — the parent object type. For company details, pass 8; for a lead, pass 1. All values are returned by the crm.enum.ownertype method
  • ENTITY_ID — the parent object identifier. For a company details address, this is the company details ID from crm.requisite.list

Address Fields

Required fields are marked with *.

Name

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

Parent object type identifier.

Object type identifiers can be obtained using the crm.enum.ownertype method.

Addresses can only be linked to Requisites (whereas Company details are already linked to companies or contacts) or Leads. For backward compatibility, the ability to link Addresses to Contacts or Companies has been retained. However, this connection is only possible on some older portals where the old address operating mode was specifically enabled by technical support

ENTITY_ID*
string

Identifier of the parent object

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

Region

COUNTRY
string

Country

COUNTRY_CODE
string

Country code

LOC_ADDR_ID
integer

Location address identifier.

This field contains the identifier of the address object in the Location module, associated with the CRM address object. For each CRM address, there is a corresponding address object in the location. This can be used to copy an existing CRM address with location information that is not present in the CRM address fields.

If an identifier for an address in the location module is specified when creating an address, a copy of the address is created location and linked to the created CRM address. If, in this case, no values are specified for the string address fields, they will be filled from the location address.

However, 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 applies when updating an address

ANCHOR_TYPE_ID
integer

Identifier of the main parent object type.

This field is for internal use. The value is automatically filled when adding an address.

Object type identifiers can be obtained using the method crm.enum.ownertype.

This field contains the identifier of the parent object type of the requisite (company or contact) if the address is linked to a requisite. If the address is linked to a lead, this value will be the lead type identifier

ANCHOR_ID
integer

This field is for internal use. The value is automatically filled when adding an address.

This field contains the identifier of the parent object of the requisite (company or contact) if the address is linked to a requisite. If the address is linked to a lead, this value will be the lead identifier

Use the method crm.address.fields to obtain a formal description of the address fields.

Overview of Methods

Scope: crm

Who can execute the methods: depending on the method — access permissions are checked against the address owner: a contact, company, or lead

Method

Description

crm.address.add

Adds a new address for a requisite or lead

crm.address.update

Modifies the address for a requisite or lead

crm.address.list

Returns a list of addresses based on a filter

crm.address.delete

Deletes an address

crm.address.fields

Returns a formal description of the address fields
Previous
Get Description of Custom Fields of Requisite Template
Next
Add address