Transfer HCM Link Field Values humanresources.hcmlink.field.value.set

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.

Scope: humanresources.hcmlink

Who can execute the method: administrator

The humanresources.hcmlink.field.value.set method transfers HR system field values for employees.

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

Method Parameters

Required parameters are marked with *

Name `type`	Description
company* `string`	Company code in the HR system or CRM company ID. You can get the company code using humanresources.hcmlink.company.list. You can get the CRM company ID using crm.item.list with the `entityTypeId = 4` parameter and the `isMyCompany = Y` filter. If `job` is passed, the company can be determined by the job
data* `array`	List of field values (detailed description)
job `object`	Data for updating the synchronization job (detailed description). Pass the parameter if the method is executed in response to the `OnHumanResourcesHcmLinkFieldValueRequested`, `OnHumanResourcesHcmLinkPinRequested`, or `OnHumanResourcesHcmLinkSalaryVacationRequested` event. The job ID is passed in the event in the `jobId` field

data Array Element

Name `type`	Description
field* `string`	Field code in the HR system. You can get the code from `fields[].field` in the response of humanresources.hcmlink.company.list
employee* `string`	Employee code in the HR system. You can get the code from `employees[].employee` in the response of humanresources.hcmlink.employee.list
value* `string`	Field value

job Parameter

Name
type

Description

id*
integer

Synchronization task identifier.

Comes in events OnHumanResourcesHcmLinkFieldValueRequested, OnHumanResourcesHcmLinkPinRequested, or OnHumanResourcesHcmLinkSalaryVacationRequested in the field jobId

fields*
object

New synchronization task data (detailed description)

job.fields Parameter

Name `type`	Description
status* `string`	New task status. Possible values: `IN_PROGRESS` — in progress `DONE` — completed `CANCELED` — cancelled
total `integer`	Total number of items in the task
sent `integer`	Number of processed items
data `object`	Additional task data

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 '{"company":"hr-company-001","data":[{"field":"personal_number","employee":"employee-001","value":"TN-1001"}],"job":{"id":101,"fields":{"status":"DONE","total":1,"sent":1}},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/humanresources.hcmlink.field.value.set

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.field.value.set',
            params: {
              company: 'hr-company-001',
              data: [
                {
                  field: 'personal_number',
                  employee: 'employee-001',
                  value: 'TN-1001',
                },
              ],
              job: {
                id: 101,
                fields: {
                  status: 'DONE',
                  total: 1,
                  sent: 1,
                },
              },
            },
            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 setHcmLinkFieldValues() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'humanresources.hcmlink.field.value.set',
                params: {
                  company: 'hr-company-001',
                  data: [
                    {
                      field: 'personal_number',
                      employee: 'employee-001',
                      value: 'TN-1001'
                    }
                  ],
                  job: {
                    id: 101,
                    fields: {
                      status: 'DONE',
                      total: 1,
                      sent: 1
                    }
                  }
                },
                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', setHcmLinkFieldValues)
        </script>

try {
            $response = $b24Service
                ->core
                ->call(
                    'humanresources.hcmlink.field.value.set',
                    [
                        'company' => 'hr-company-001',
                        'data' => [
                            [
                                'field' => 'personal_number',
                                'employee' => 'employee-001',
                                'value' => 'TN-1001',
                            ],
                        ],
                        'job' => [
                            'id' => 101,
                            'fields' => [
                                'status' => 'DONE',
                                'total' => 1,
                                'sent' => 1,
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error setting field values: ' . $e->getMessage();
        }

BX24.callMethod(
            'humanresources.hcmlink.field.value.set',
            {
                company: 'hr-company-001',
                data: [{ field: 'personal_number', employee: 'employee-001', value: 'TN-1001' }],
                job: { id: 101, fields: { status: 'DONE', total: 1, sent: 1 } }
            },
            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.field.value.set',
            [
                'company' => 'hr-company-001',
                'data' => [
                    [
                        'field' => 'personal_number',
                        'employee' => 'employee-001',
                        'value' => 'TN-1001',
                    ],
                ],
                'job' => [
                    'id' => 101,
                    'fields' => [
                        'status' => 'DONE',
                        'total' => 1,
                        'sent' => 1,
                    ],
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

// client and ctx are already created — see section "SDK for Go"
        res, err := client.Core().Call(ctx, "humanresources.hcmlink.field.value.set", b24.Params{
        	"company": "hr-company-001",
        	"data": []b24.Params{
        		{
        			"field":    "personal_number",
        			"employee": "employee-001",
        			"value":    "TN-1001",
        		},
        	},
        	"job": b24.Params{
        		"id": 101,
        		"fields": b24.Params{
        			"status": "DONE",
        			"total":  1,
        			"sent":   1,
        		},
        	},
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("humanresources.hcmlink.field.value.set: %w", err)
        }
        
        var result struct {
        	Status string   `json:"status"`
        	Errors []string `json:"errors"`
        }
        if err := json.Unmarshal(res.Result, &result); err != nil {
        	return fmt.Errorf("response breakdown: %w", err)
        }
        fmt.Println(result.Status, result.Errors)

Response Handling

HTTP status: 200

{
            "result": {
                "status": "ok",
                "errors": []
            },
            "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 `object`	Field value processing result
time `time`	Request execution time information

result Object Fields

Name
type

Description

status
string

Processing status.

Possible values:

ok — values were processed without errors
error — errors occurred during processing

errors
array

List of item processing errors

Error Handling

HTTP status: 200, 403

{
            "result": {
                "status": "error",
                "errors": [
                    "Parameter 'data' must be a non empty 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	When It Occurs
`0`	Operation failed	Failed to update the synchronization job passed in the `job` parameter
`-`	Parameter 'data' must be a non empty array	The field value list is not passed
`-`	Item #... field '...' not found for company '...'	The field was not found in the company
`-`	Item #... employee '...' not found for company '...'	The employee was not found in the company
`-`	Item #... does not match PIN request job '...'	The value does not match the PIN request job
`-`	Item #... does not match salary/vacation request job '...'	The value does not match the payroll or vacation balance request job
`-`	Job '...' result is incomplete	The `DONE` status was passed for the job, but the response does not contain all requested values
`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: 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 permitted for calls 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 HTTPS protocol is required for method calls
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is only available on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user associated with the access token or webhook used to call the method lacks the necessary 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 portal administrator has restricted access to this application to specific users only
`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 "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?

Get Mapped Employee List

Update Synchronization Job

Transfer HCM Link Field Values humanresources.hcmlink.field.value.set

Method ParametersMethod Parameters

data Array Elementdata Array Element

job Parameterjob Parameter

job.fields Parameterjob.fields Parameter

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

result Object Fieldsresult Object Fields

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning