Add a Company to the Specified Contact crm.contact.company.add

Scope: crm

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

The method crm.contact.company.add adds a company to the specified contact.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
integer

Identifier of the contact.

Can be obtained using the methods crm.contact.list or crm.contact.add

fields*
object

Object format:

{
            field_1: value_1,
            field_2: value_2,
            ...,
            field_n: value_n,
        }

where:

field_n — field name
value_n — field value

The list of available fields is described below.

Parameter fields

Required parameters are marked with *

Name `type`	Description
COMPANY_ID* `crm_entity`	Identifier of the company that will be linked to the contact. The identifier can be obtained using the method crm.item.list with `entityTypeId = 4`
IS_PRIMARY `boolean`	Indicates whether the link is primary. Possible values: `Y` — yes `N` — no For the first added element, `IS_PRIMARY` is `Y` by default. Passing `IS_PRIMARY = Y` for a new and not first link overrides the existing primary link
SORT `integer`	Sort index. By default, `i + 10`, where `i` is the maximum sort index of existing links for the current contact or `0` if there are none

Code Examples

How to Use Examples in Documentation

Example of adding a contact-company link, where:

contact identifier — 54
company identifier — 32

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":54,"fields":{"COMPANY_ID":32,"IS_PRIMARY":"Y","SORT":1000}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.contact.company.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":54,"fields":{"COMPANY_ID":32,"IS_PRIMARY":"Y","SORT":1000},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.contact.company.add

try
        {
        	const response = await $b24.callMethod(
        		'crm.contact.company.add',
        		{
        			id: 54,
        			fields: {
        				COMPANY_ID: 32,
        				IS_PRIMARY: "Y",
        				SORT: 1000,
        			},
        		}
        	);
        	
        	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.add',
                    [
                        'id' => 54,
                        'fields' => [
                            'COMPANY_ID' => 32,
                            'IS_PRIMARY' => 'Y',
                            'SORT' => 1000,
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                echo 'Error: ' . $result->error();
            } else {
                echo 'Data: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding contact company: ' . $e->getMessage();
        }

BX24.callMethod(
            'crm.contact.company.add',
            {
                id: 54,
                fields: {
                    COMPANY_ID: 32,
                    IS_PRIMARY: "Y",
                    SORT: 1000,
                },
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.contact.company.add',
            [
                'id' => 54,
                'fields' => [
                    'COMPANY_ID' => 32,
                    'IS_PRIMARY' => 'Y',
                    'SORT' => 1000,
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": true,
            "time": {
                "start": 1724068028.331234,
                "finish": 1724068028.726591,
                "duration": 0.3953571319580078,
                "processing": 0.13033390045166016,
                "date_start": "2024-08-19T13:47:08+02:00",
                "date_finish": "2024-08-19T13:47:08+02:00"
            }
        }

Returned Data

Name
type

Description

result
boolean

Root element of the response. Contains:

true — on success
false — on failure (most likely the company you are trying to add is already linked)

time
time

Information about the execution time of the request

Error Handling

HTTP status: 400

{
            "error": "",
            "error_description": "The parameter 'ownerEntityID' is invalid or not defined."
        }

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 `id` is less than 0 or not provided at all
`-`	`The parameter 'fields' must be array`	The `fields` is not an object
`ACCESS_DENIED`	`Access denied!`	The user does not have permission to edit contacts
`-`	`Not found`	Contact with the provided `id` not found
`-`	`The parameter 'fields' is not valid`	Can occur for several reasons: if the required parameter `fields.COMPANY_ID` is not provided if the provided parameter `fields.COMPANY_ID` is less than or equal to 0

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

Remove a Company from the Specified Contact

Add a Company to the Specified Contact crm.contact.company.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