Transfer HCM Link Employee List humanresources.hcmlink.employee.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:
humanresources.hcmlinkWho can execute the method: administrator
The humanresources.hcmlink.employee.set method transfers a list of employees 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 |
Description |
|
company* |
Company code in the HR system. You can get the code using humanresources.hcmlink.company.list |
|
data* |
List of employees from the HR system (detailed description) |
|
job |
Data for updating the synchronization job (detailed description). Pass the parameter if the method is executed in response to the |
data Array Element
|
Name |
Description |
|
employee* |
Employee code in the HR system |
|
person* |
Individual code in the HR system |
|
userId |
Bitrix24 user ID. You can get the ID using user.get |
|
data* |
Employee data (detailed description). The object must contain at least one field with a non-empty value |
data.data Parameter
|
Name |
Description |
|
firstName |
First name |
|
lastName |
Last name |
|
patronymicName |
Middle name |
job Parameter
|
Name |
Description |
|
id* |
Synchronization job ID. Passed in the |
|
fields* |
New synchronization job data (detailed description) |
job.fields Parameter
|
Name |
Description |
|
status* |
New job status. Possible values:
|
|
total |
Total number of items in the job |
|
sent |
Number of processed items |
|
data |
Additional job data |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"company":"hr-company-001","data":[{"employee":"employee-001","person":"person-001","userId":25,"data":{"firstName":"Klaus","lastName":"Weber","patronymicName":"Klaus","position":"Manager"}}],"job":{"id":101,"fields":{"status":"DONE","total":1,"sent":1}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/humanresources.hcmlink.employee.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.employee.set',
params: {
company: 'hr-company-001',
data: [
{
employee: 'employee-001',
person: 'person-001',
userId: 25,
data: {
firstName: 'Klaus',
lastName: 'Weber',
patronymicName: 'Klaus',
position: 'Manager',
},
},
],
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 setHcmLinkEmployees() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'humanresources.hcmlink.employee.set',
params: {
company: 'hr-company-001',
data: [
{
employee: 'employee-001',
person: 'person-001',
userId: 25,
data: {
firstName: 'Klaus',
lastName: 'Weber',
patronymicName: 'Klaus',
position: 'Manager'
}
}
],
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', setHcmLinkEmployees)
</script>
try {
$response = $b24Service
->core
->call(
'humanresources.hcmlink.employee.set',
[
'company' => 'hr-company-001',
'data' => [
[
'employee' => 'employee-001',
'person' => 'person-001',
'userId' => 25,
'data' => [
'firstName' => 'Klaus',
'lastName' => 'Weber',
'patronymicName' => 'Klaus',
'position' => 'Manager',
],
],
],
'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 employees: ' . $e->getMessage();
}
BX24.callMethod(
'humanresources.hcmlink.employee.set',
{
company: 'hr-company-001',
data: [{ employee: 'employee-001', person: 'person-001', userId: 25, data: { firstName: 'Klaus', lastName: 'Weber' } }],
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.employee.set',
[
'company' => 'hr-company-001',
'data' => [
[
'employee' => 'employee-001',
'person' => 'person-001',
'userId' => 25,
'data' => [
'firstName' => 'Klaus',
'lastName' => 'Weber',
'patronymicName' => 'Klaus',
'position' => 'Manager',
],
],
],
'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.employee.set", b24.Params{
"company": "hr-company-001",
"data": []b24.Params{
{
"employee": "employee-001",
"person": "person-001",
"userId": 25,
"data": b24.Params{
"firstName": "Klaus",
"lastName": "Weber",
"patronymicName": "Klaus",
"position": "Manager",
},
},
},
"job": b24.Params{
"id": 101,
"fields": b24.Params{
"status": "DONE",
"total": 1,
"sent": 1,
},
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("humanresources.hcmlink.employee.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 |
Description |
|
result |
Employee list processing result |
|
time |
Request execution time information |
result Object Fields
|
Name |
Description |
|
status |
Processing status. Possible values:
|
|
errors |
List of item processing errors |
Error Handling
HTTP status: 200, 403
{
"result": {
"status": "error",
"errors": [
"Parameter 'data' must be a non empty array "
]
}
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
When It Occurs |
|
|
Operation failed |
Failed to update the synchronization job passed in the |
|
|
Parameter 'data' must be a non empty array |
The employee list is not passed |
|
|
Item #... should have not empty 'employee', 'person', 'data' |
A list item has no required fields |
|
|
Access denied! Access denied. |
The user is not an administrator |
|
|
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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
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 — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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 |