Set the Set of Companies Associated with the Specified Contact crm.contact.company.items.set

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 the "Edit" access permission for the contact and the "Read" access permission for the companies

DEPRECATED

The development of this method has been halted. Please use the REST 3.0 method crm.contact.update with the companiesId array: the first company in the array becomes the primary one. The method does not accept an explicit SORT value, so use this method for it.

The method crm.contact.company.items.set sets the set of companies associated with the specified contact.

The method replaces the entire set: companies that are not in items are unlinked from the contact. To add or remove a single company without affecting the others, use crm.contact.company.add and crm.contact.company.delete. The structure of the binding object is described in the section overview.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
integer

Identifier of the contact. Must be greater than 0.

The identifier can be retrieved using the method crm.item.list with entityTypeId = 3

items*
object[]

A set of objects that describe the contact's companies. The structure of the binding object is described below.

An empty array unlinks all companies from the contact.

The method skips elements without COMPANY_ID or with a value less than or equal to 0 without an error

Parameter items

Required parameters are marked with *

Name
type

Description

COMPANY_ID*
crm_entity

Identifier of the company to be linked to the contact.

The identifier can be retrieved using the method crm.item.list with entityTypeId = 4.

The method does not separately check whether the company exists, so it can create a binding to a non-existent company

IS_PRIMARY
char

Whether to make the company primary for the contact. Possible values:

  • Y — yes
  • N — no

The first company in items with IS_PRIMARY = Y becomes primary, or, if there is none, the first company in items. For the other companies, the flag is reset to N.

The primary company is written to the contact field COMPANY_ID

SORT
integer

Sort index.

If SORT is not passed or is less than or equal to 0, the method calculates it from the company's position in items as (n + 1) * 10, where n is the zero-based position of the company in items. The first company gets 10, the second gets 20, and so on

The rule also applies to already linked companies: if you do not pass SORT, the method overwrites their previous sort index. To keep the order, retrieve the set with the method crm.contact.company.items.get and pass SORT for each company.

Code Examples

How to Use Examples in Documentation

Set the following associated companies for the contact with id = 82:

  • company with id = 8, make it primary and set SORT = 100
  • company with id = 9, set SORT = 200
  • company with id = 10, set SORT = 400
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":82,"items":[{"COMPANY_ID":8,"IS_PRIMARY":"Y","SORT":100},{"COMPANY_ID":9,"SORT":200},{"COMPANY_ID":10,"SORT":400}]}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.contact.company.items.set
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":82,"items":[{"COMPANY_ID":8,"IS_PRIMARY":"Y","SORT":100},{"COMPANY_ID":9,"SORT":200},{"COMPANY_ID":10,"SORT":400}],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.contact.company.items.set
        
// 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<boolean>({
            method: 'crm.contact.company.items.set',
            params: {
              id: 82,
              items: [
                {
                  COMPANY_ID: 8,
                  IS_PRIMARY: 'Y',
                  SORT: 100,
                },
                {
                  COMPANY_ID: 9,
                  SORT: 200,
                },
                {
                  COMPANY_ID: 10,
                  SORT: 400,
                },
              ],
            },
            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('Contact companies set:', 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 setContactCompanyItems() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.contact.company.items.set',
                params: {
                  id: 82,
                  items: [
                    {
                      COMPANY_ID: 8,
                      IS_PRIMARY: 'Y',
                      SORT: 100,
                    },
                    {
                      COMPANY_ID: 9,
                      SORT: 200,
                    },
                    {
                      COMPANY_ID: 10,
                      SORT: 400,
                    },
                  ],
                },
                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('Contact companies set:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', setContactCompanyItems)
        </script>
        

        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.contact.company.items.set(
                bitrix_id=82,
                items=[
                    {
                        "COMPANY_ID": 8,
                        "IS_PRIMARY": "Y",
                        "SORT": 100,
                    },
                    {
                        "COMPANY_ID": 9,
                        "SORT": 200,
                    },
                    {
                        "COMPANY_ID": 10,
                        "SORT": 400,
                    },
                ],
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.contact.company.items.set',
                    [
                        'id'    => 82,
                        'items' => [
                            [
                                'COMPANY_ID' => 8,
                                'IS_PRIMARY' => 'Y',
                                'SORT'       => 100,
                            ],
                            [
                                'COMPANY_ID' => 9,
                                'SORT'       => 200,
                            ],
                            [
                                'COMPANY_ID' => 10,
                                'SORT'       => 400,
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . var_export($result[0], true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error setting company items for contact: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'crm.contact.company.items.set',
            {
                id: 82,
                items: [
                    {
                        COMPANY_ID: 8,
                        IS_PRIMARY: "Y",
                        SORT: 100,
                    },
                    {
                        COMPANY_ID: 9,
                        SORT: 200,
                    },
                    {
                        COMPANY_ID: 10,
                        SORT: 400,
                    }
                ],
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.contact.company.items.set',
            [
                'id' => 82,
                'items' => [
                    [
                        'COMPANY_ID' => 8,
                        'IS_PRIMARY' => 'Y',
                        'SORT' => 100,
                    ],
                    [
                        'COMPANY_ID' => 9,
                        'SORT' => 200,
                    ],
                    [
                        'COMPANY_ID' => 10,
                        'SORT' => 400,
                    ]
                ]
            ]
        );
        
        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.company.items.set", b24.Params{
        	"id": 82,
        	"items": []b24.Params{
        		{
        			"COMPANY_ID": 8,
        			"IS_PRIMARY": "Y",
        			"SORT":       100,
        		},
        		{
        			"COMPANY_ID": 9,
        			"SORT":       200,
        		},
        		{
        			"COMPANY_ID": 10,
        			"SORT":       400,
        		},
        	},
        })
        if err != nil {
        	return fmt.Errorf("crm.contact.company.items.set: %w", err)
        }
        
        var ok bool
        if err := json.Unmarshal(res.Result, &ok); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println("done:", ok)
        

Response Handling

HTTP status: 200

{
            "result": true,
            "time": {
                "start": 1724139480.073569,
                "finish": 1724139481.016709,
                "duration": 0.9431400299072266,
                "processing": 0.4230809211730957,
                "date_start": "2024-08-20T09:38:00+02:00",
                "date_finish": "2024-08-20T09:38:01+02:00",
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
boolean

Root element of the response. Contains true in case of success.

The method also returns true when the passed set matches the current one

time
time

Information about the request execution time

Error Handling

HTTP status: 400

{
            "error": "",
            "error_description": "The parameter items 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

Status

Code

Description

Value

400

Empty value

The parameter ownerEntityID is invalid or not defined.

The id parameter is not passed or is less than or equal to 0

400

Empty value

The parameter items must be array.

The items parameter is not passed or is not an array

400

Empty value

Access denied.

The user does not have read access to CRM objects, including those in digital workspaces

403

ACCESS_DENIED

Access denied!

The user does not have permission to edit the contact

400

Empty value

Not found.

The contact with the provided id was not found

400

Empty value

[Company #1] You don't have permission to view this item.

The user does not have permission to read the companies. The method checks this permission only if the call changes something in the bindings

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