Set the set of companies associated with the specified contact crm.contact.company.items.set

Scope: crm

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

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

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
integer

Identifier of the contact.

The identifier can be obtained using the methods crm.contact.list or crm.contact.add

items*
object[]

A set of objects that describe the associated companies for the contact. The structure of an individual binding object is described below

Structure of the Binding Object

Required parameters are marked with *

Name `type`	Description
COMPANY_ID* `crm_entity`	Identifier of the company that will be associated with the contact. The identifier can be obtained using the method crm.item.list with `entityTypeId = 4`
IS_PRIMARY `boolean`	Indicates whether the binding is primary. Possible values: `Y` — yes `N` — no If there is no binding with `IS_PRIMARY = Y`, it will be set for the first binding in `items`. If multiple bindings are provided with `IS_PRIMARY = Y`, the first binding with `IS_PRIMARY = Y` will be considered primary
SORT `integer`	Sort index. By default, `i + 10`, where `i` is the maximum sort index of existing and provided bindings for the current contact or `0` if `SORT` is not provided for any of the bindings and if the contact has no bindings. If an existing binding is provided without the `SORT` parameter, the default value will not be set (the value will remain the same)

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 (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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

try
        {
        	const response = await $b24.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,
        				}
        			],
        		}
        	);
        	
        	const result = response.getData().result;
        	result.error()
        		? console.error(result.error())
        		: console.info(result)
        	;
        }
        catch( error )
        {
        	console.error('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();
        
            if ($result->error()) {
                echo 'Error: ' . $result->error();
            } else {
                echo 'Success: ' . print_r($result->data(), true);
                // Your logic for processing data
                processData($result->data());
            }
        
        } 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>';

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
time `time`	Information about the execution time of the request

Error Handling

HTTP Status: 400

{
            "error": "",
            "error_description": "The parameter items must be array."
        }

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
`-`	`The parameter ownerEntityID is invalid or not defined`	The provided `id` is less than 0 or not provided at all
`-`	`The parameter items must be array`	A non-array value was provided in `items`
`ACCESS_DENIED`	`Access denied!`	The user does not have permission to edit contacts
`-`	`Not found`	The contact with the provided `id` was not found

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

Get Set of Companies Linked to the Specified Contact

Clear the Set of Companies Linked to the Specified Contact

Set the set of companies associated with the specified contact crm.contact.company.items.set

Method ParametersMethod Parameters

Structure of the Binding ObjectStructure of the Binding Object

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