Invite a user user.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:
userWho can execute the method: administrator
The user.add method invites a user. This is only possible on behalf of a user with user invitation rights, typically an administrator. Upon success, the user will be sent a standard invitation to the account. In result, the identifier of the new user is returned.
If you need to add an extranet user, you must pass the following fields: EXTRANET: Y and SONET_GROUP_ID: [...]. If you need to add an intranet user, the following must be provided:UF_DEPARTMENT: [...].
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
EMAIL* |
User e-mail |
|
NAME |
First name |
|
LAST_NAME |
Last name |
|
SECOND_NAME |
Middle name |
|
PERSONAL_GENDER |
Gender |
|
PERSONAL_PROFESSION |
Profession |
|
PERSONAL_WWW |
Home page |
|
PERSONAL_BIRTHDAY |
Date of birth |
|
PERSONAL_PHOTO |
Photo, pass an array containing the file name and a Base64 string |
|
PERSONAL_ICQ |
ICQ |
|
PERSONAL_PHONE |
Personal phone |
|
PERSONAL_FAX |
Fax |
|
PERSONAL_MOBILE |
Personal mobile |
|
PERSONAL_PAGER |
Pager |
|
PERSONAL_STREET |
Residential street |
|
PERSONAL_CITY |
City of residence |
|
PERSONAL_STATE |
Region / province |
|
PERSONAL_ZIP |
Postal code |
|
PERSONAL_COUNTRY |
Country |
|
PERSONAL_MAILBOX |
P.O. box |
|
PERSONAL_NOTES |
Additional notes |
|
WORK_PHONE |
Company phone |
|
WORK_COMPANY |
company |
|
WORK_POSITION |
Job title |
|
WORK_DEPARTMENT |
Department |
|
WORK_WWW |
Company website |
|
WORK_FAX |
WORK_FAX |
|
WORK_PAGER |
WORK_PAGER |
|
WORK_STREET |
WORK_STREET |
|
WORK_MAILBOX |
WORK_MAILBOX |
|
WORK_CITY |
Work city |
|
WORK_STATE |
WORK_STATE |
|
WORK_ZIP |
WORK_ZIP |
|
WORK_COUNTRY |
WORK_COUNTRY |
|
WORK_PROFILE |
WORK_PROFILE |
|
WORK_LOGO |
WORK_LOGO |
|
WORK_NOTES |
WORK_NOTES |
|
UF_SKYPE_LINK |
Skype chat link |
|
UF_ZOOM |
Zoom |
|
UF_DEPARTMENT |
Department |
|
UF_INTERESTS |
Interests |
|
UF_SKILLS |
Skills |
|
UF_WEB_SITES |
Other websites |
|
UF_XING |
|
|
UF_LINKEDIN |
|
|
UF_FACEBOOK |
|
|
UF_TWITTER |
|
|
UF_SKYPE |
Skype |
|
UF_DISTRICT |
District |
|
UF_PHONE_INNER |
Extension |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"EMAIL": "newuser1@example.com",
"UF_DEPARTMENT": [1]
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/user.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"EMAIL": "newuser1@example.com",
"UF_DEPARTMENT": [1],
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/user.add
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
try {
const response = await $b24.actions.v2.call.make<number>({
method: 'user.add',
params: {
EMAIL: 'newuser1@example.com',
UF_DEPARTMENT: [1]
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('New user ID:', result)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function addUser() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'user.add',
params: {
EMAIL: 'newuser1@example.com',
UF_DEPARTMENT: [1]
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('New user ID:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addUser)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.user.add(
fields={
"EMAIL": "newuser1@example.com",
"UF_DEPARTMENT": [
1,
],
},
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
try {
$response = $b24Service
->core
->call(
'user.add',
[
'EMAIL' => 'newuser1@example.com',
'UF_DEPARTMENT' => [1],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding user: ' . $e->getMessage();
}
BX24.callMethod(
"user.add",
{
"EMAIL": "newuser1@example.com",
"UF_DEPARTMENT": [1]
},
function(result)
{
if(result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'user.add',
[
'EMAIL' => 'newuser1@example.com',
'UF_DEPARTMENT' => [1]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "user.add", b24.Params{
"EMAIL": "newuser1@example.com",
"UF_DEPARTMENT": []int{1},
})
if err != nil {
return fmt.Errorf("user.add: %w", err)
}
var newID b24.ID
if err := json.Unmarshal(res.Result, &newID); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println("id:", newID)
Response Handling
HTTP status: 200
{
"result":12,
"time":{
"start":1721733827.713938,
"finish":1721733828.286292,
"duration":0.5723540782928467,
"processing":0.5508849620819092,
"date_start":"2024-07-23T11:23:47+00:00",
"date_finish":"2024-07-23T11:23:48+00:00",
"operating":0.5508630275726318
}
}
Returned Data
|
Name |
Description |
|
result |
New user identifier |
|
time |
Request execution time information |
Error Handling
HTTP status: 400
{
"error": "ERROR_ARGUMENT",
"error_description": "wrong_email",
"argument": ""
}
|
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 |
Error message |
Description |
|
|
wrong_email |
Parameter |
|
|
A user with this email already exists |
Attempt to register a user with an e-mail that is already taken |
|
|
access_denied |
User does not have permission to call the method |
|
|
user_count_exceeded |
User limit exceeded |
|
|
Group code not specified |
Group code not specified when adding a user to the extranet |
|
|
Group is specified incorrectly |
Group is incorrectly specified when adding a user |
|
|
no_extranet_field |
When calling the method, the group the user should belong to was not specified |
|
|
Error updating user fields |
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 |