Add HCM Link Company humanresources.hcmlink.company.add

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: humanresources.hcmlink

Who can execute the method: administrator

The humanresources.hcmlink.company.add method adds a company from an HR system to the HCM Link integration.

The method can only be executed in the context of authorization of the application.

Method Parameters

Required parameters are marked with *

Name `type`	Description
fields* `object`	Company data from the HR system (detailed description)

fields Parameter

Name `type`	Description
company* `string`	Company code in the HR system
crmCompanyId* `integer`	CRM company ID. You can get the ID using crm.item.list with the `entityTypeId = 4` parameter and the `isMyCompany = Y` filter
title* `string`	Company name
data `object`	Additional company data
fields* `array`	List of HR system fields (detailed description)

fields.fields Array Element

Name `type`	Description
field* `string`	Field code in the HR system
title* `string`	Field name
type `string`	Field type. If no value is passed, the method saves the field with the internal `UNKNOWN` type. Possible values: `STRING` — string `FIRST_NAME` — first name `LAST_NAME` — last name `PATRONYMIC_NAME` — middle name `PHONE` — phone `EMAIL` — email address `ADDRESS` — address `BIRTHDAY` — date of birth `POSITION` — position `DEPARTMENT` — department `DOCUMENT_REGISTRATION_NUMBER` — document registration number `DOCUMENT_UID` — unique document ID `DOCUMENT_DATE` — document date
entityType `string`	Type of object the field belongs to. If no value is passed, the method saves the field with the internal `UNKNOWN` type. Possible values: `EMPLOYEE` — employee `COMPANY` — company `DOCUMENT` — document
ttl `integer`	Field value storage time in seconds. Default value: 86400

Code Examples

How to Use Examples in Documentation

cURL (OAuth)

JS (TS)

JS (UMD)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"company":"hr-company-001","crmCompanyId":12,"title":"Muller GmbH","data":{"taxId":"1234567890"},"fields":[{"field":"personal_number","title":"Personnel Number","type":"STRING","entityType":"EMPLOYEE","ttl":86400}]},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/humanresources.hcmlink.company.add

import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        try {
          const response = await $b24.actions.v2.call.make({
            method: 'humanresources.hcmlink.company.add',
            params: {
              fields: {
                company: 'hr-company-001',
                crmCompanyId: 12,
                title: 'Muller GmbH',
                data: {
                  taxId: '1234567890',
                },
                fields: [
                  {
                    field: 'personal_number',
                    title: 'Personnel Number',
                    type: 'STRING',
                    entityType: 'EMPLOYEE',
                    ttl: 86400,
                  },
                ],
              },
            },
            requestId: Text.getUuidRfc4122()
          })
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            console.info(response.getData()!.result)
          }
        } catch (error) {
          console.error(error)
        }

<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function addHcmLinkCompany() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'humanresources.hcmlink.company.add',
                params: {
                  fields: {
                    company: 'hr-company-001',
                    crmCompanyId: 12,
                    title: 'Muller GmbH',
                    data: {
                      taxId: '1234567890'
                    },
                    fields: [
                      {
                        field: 'personal_number',
                        title: 'Personnel Number',
                        type: 'STRING',
                        entityType: 'EMPLOYEE',
                        ttl: 86400
                      }
                    ]
                  }
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              console.info(response.getData().result)
            } catch (error) {
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addHcmLinkCompany)
        </script>

try {
            $response = $b24Service
                ->core
                ->call(
                    'humanresources.hcmlink.company.add',
                    [
                        'fields' => [
                            'company' => 'hr-company-001',
                            'crmCompanyId' => 12,
                            'title' => 'Muller GmbH',
                            'data' => [
                                'taxId' => '1234567890',
                            ],
                            'fields' => [
                                [
                                    'field' => 'personal_number',
                                    'title' => 'Personnel Number',
                                    'type' => 'STRING',
                                    'entityType' => 'EMPLOYEE',
                                    'ttl' => 86400,
                                ],
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding company: ' . $e->getMessage();
        }

BX24.callMethod(
            'humanresources.hcmlink.company.add',
            {
                fields: {
                    company: 'hr-company-001',
                    crmCompanyId: 12,
                    title: 'Muller GmbH',
                    data: { taxId: '1234567890' },
                    fields: [{ field: 'personal_number', title: 'Personnel Number', type: 'STRING', entityType: 'EMPLOYEE', ttl: 86400 }]
                }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error(), result.error_description());
                }
                else
                {
                    console.dir(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'humanresources.hcmlink.company.add',
            [
                'fields' => [
                    'company' => 'hr-company-001',
                    'crmCompanyId' => 12,
                    'title' => 'Muller GmbH',
                    'data' => [
                        'taxId' => '1234567890',
                    ],
                    'fields' => [
                        [
                            'field' => 'personal_number',
                            'title' => 'Personnel Number',
                            'type' => 'STRING',
                            'entityType' => 'EMPLOYEE',
                            'ttl' => 86400,
                        ],
                    ],
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

// client and ctx are already created — see the "SDK for Go" section
        res, err := client.Core().Call(ctx, "humanresources.hcmlink.company.add", b24.Params{
        	"fields": b24.Params{
        		"company":      "hr-company-001",
        		"crmCompanyId": 12,
        		"title":        "Muller GmbH",
        		"data": b24.Params{
        			"taxId": "1234567890",
        		},
        		"fields": []b24.Params{
        			{
        				"field":      "personal_number",
        				"title":      "Personnel Number",
        				"type":       "STRING",
        				"entityType": "EMPLOYEE",
        				"ttl":        86400,
        			},
        		},
        	},
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("humanresources.hcmlink.company.add: %w", err)
        }
        
        var id int
        if err := json.Unmarshal(res.Result, &id); err != nil {
        	return fmt.Errorf("response parsing: %w", err)
        }
        fmt.Println(id)

Response Handling

HTTP status: 200

{
            "result": 15,
            "time": {
                "start": 1739860000.123,
                "finish": 1739860000.456,
                "duration": 0.333,
                "processing": 0.111,
                "date_start": "2026-08-06T19:51:02+03:00",
                "date_finish": "2026-08-06T19:51:02+03:00"
            }
        }

Returned Data

Name `type`	Description
result `integer`	ID of the added HCM Link company
time `time`	Request execution time information

Error Handling

HTTP status: 200, 403

{
            "error": 0,
            "error_description": "Operation failed"
        }

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

Code	Description	When It Occurs
`0`	Operation failed	`crmCompanyId`, `company`, `title`, or `fields` is not passed; a save error occurred
`510`	Operation failed	CRM company was not found
`ACCESS_DENIED`	Access denied! Access denied.	The user is not an administrator
`WRONG_AUTH_TYPE`	Application context required	The method was not called in the application context

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

Was the article helpful?

Overview of Methods

Update Company

Add HCM Link Company humanresources.hcmlink.company.add

Method ParametersMethod Parameters

fields Parameterfields Parameter

fields.fields Array Elementfields.fields Array Element

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