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: user

Who can execute the method: administrator, and in cloud Bitrix24 also a user with permission to invite employees

The user.add method invites a user to Bitrix24 and sends an invitation to EMAIL. For an employee, pass the department in UF_DEPARTMENT; for an external extranet user, pass EXTRANET and SONET_GROUP_ID.

The method works only in the user scope version. In the user_brief and user_basic versions, the call returns the insufficient_scope error. For details, see the User Scope Versions article. The onUserAdd event does not fire immediately, but when the invited user logs in to Bitrix24 for the first time and completes registration.

Method Parameters

Required parameters are marked with *

Name `type`	Description
EMAIL* `string`	User e-mail. The invitation is sent to it. The address must pass the Bitrix24.Network check
NAME `string`	First name
LAST_NAME `string`	Last name
SECOND_NAME `string`	Middle name
PERSONAL_GENDER `string`	Gender: `M` — male `F` — female
PERSONAL_PROFESSION `string`	Profession
PERSONAL_WWW `string`	Personal website
PERSONAL_BIRTHDAY `date`	Date of birth in ISO 8601 format, for example `1990-05-20`
PERSONAL_PHOTO `array`	Photo, an array of two strings: the file name and the content in Base64, for example `["photo.png", "iVBORw0KGgo..."]`
PERSONAL_ICQ `string`	ICQ
PERSONAL_PHONE `string`	Personal phone
PERSONAL_FAX `string`	Personal fax
PERSONAL_MOBILE `string`	Personal mobile
PERSONAL_PAGER `string`	Pager
PERSONAL_STREET `string`	Residential street
PERSONAL_CITY `string`	City of residence
PERSONAL_STATE `string`	Residential region or territory
PERSONAL_ZIP `string`	Postal code
PERSONAL_COUNTRY `string`	Numeric code of the country of residence from the Bitrix24 country directory. The code of an already specified country is returned in the `PERSONAL_COUNTRY` field of the user.get response
PERSONAL_MAILBOX `string`	P.O. box
PERSONAL_NOTES `string`	Additional notes
WORK_PHONE `string`	Work phone
WORK_COMPANY `string`	company
WORK_POSITION `string`	Job title
WORK_DEPARTMENT `string`	Department, a text field. Pass the department from the company structure in `UF_DEPARTMENT`
WORK_WWW `string`	Company website
WORK_FAX `string`	Work fax
WORK_PAGER `string`	Work pager
WORK_STREET `string`	Street of the company address
WORK_MAILBOX `string`	Company P.O. box
WORK_CITY `string`	Work city
WORK_STATE `string`	State or region of the company address
WORK_ZIP `string`	Company postal code
WORK_COUNTRY `string`	Numeric code of the company address country from the Bitrix24 country directory. The code of an already specified country is returned in the `WORK_COUNTRY` field of the user.get response
WORK_PROFILE `string`	Company's areas of business
WORK_LOGO `array`	Company logo. Pass an array of the file name and a Base64 string, as for `PERSONAL_PHOTO`
WORK_NOTES `string`	Notes about the workplace
UF_SKYPE_LINK `string`	Skype chat link
UF_ZOOM `string`	Zoom
UF_DEPARTMENT `integer[]`	IDs of departments from the company structure. Retrieve departments using department.get. Required for an employee if `EXTRANET` = `Y` is not passed. Without it, the method returns the `no_extranet_field` error
UF_INTERESTS `string`	Interests
UF_SKILLS `string`	Skills
UF_WEB_SITES `string`	Other websites
UF_XING `string`	Xing
UF_LINKEDIN `string`	LinkedIn
UF_FACEBOOK `string`	Facebook
UF_TWITTER `string`	Twitter
UF_SKYPE `string`	Microsoft Teams. The field code is kept from Skype
UF_DISTRICT `string`	District
UF_PHONE_INNER `string`	Extension
EXTRANET `string`	Invite an external extranet user: `Y` — invite to the extranet Any other value or no parameter invites an employee, which requires `UF_DEPARTMENT`. Together with `EXTRANET` = `Y`, you must pass `SONET_GROUP_ID`. In this case, the `UF_DEPARTMENT` value is ignored. Works if the extranet module is installed in Bitrix24
SONET_GROUP_ID `integer[]`	IDs of the workgroups to which the extranet user is invited. You can pass a single number. Retrieve groups using sonet_group.get. Required if `EXTRANET` = `Y` is passed. Without it, the method returns the `no_sonet_group_for_extranet` error
MESSAGE_TEXT `string`	Invitation text. If not passed, the standard text is used

Code Examples

How to Use Examples in Documentation

Invite an Employee

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

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();
        
            print_r($result);
        } catch (Throwable $e) {
            echo $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)

Invite an Extranet User

The user receives an invitation to workgroup 7. The UF_DEPARTMENT department is not passed for this user.

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{
            "EMAIL": "partner@example.com",
            "EXTRANET": "Y",
            "SONET_GROUP_ID": [7]
        }' \
        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": "partner@example.com",
            "EXTRANET": "Y",
            "SONET_GROUP_ID": [7],
            "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: 'partner@example.com',
              EXTRANET: 'Y',
              SONET_GROUP_ID: [7]
            },
            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: 'partner@example.com',
                  EXTRANET: 'Y',
                  SONET_GROUP_ID: [7]
                },
                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": "partner@example.com",
                    "EXTRANET": "Y",
                    "SONET_GROUP_ID": [
                        7,
                    ],
                },
            ).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'        => 'partner@example.com',
                        'EXTRANET' => 'Y',
                        'SONET_GROUP_ID' => [7],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }

BX24.callMethod(
            "user.add",
            {
                "EMAIL": "partner@example.com",
                "EXTRANET": "Y",
                "SONET_GROUP_ID": [7]
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'user.add',
            [
                'EMAIL' => 'partner@example.com',
                'EXTRANET' => 'Y',
                'SONET_GROUP_ID' => [7]
            ]
        );
        
        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":         "partner@example.com",
        	"EXTRANET":      "Y",
        	"SONET_GROUP_ID": []int{7},
        })
        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 `type`	Description
result `integer`	New user identifier
time `time`	Request execution time information

Error Handling

HTTP status: 400

{
            "error": "ERROR_ARGUMENT",
            "error_description": "no_extranet_field",
            "argument": ""
        }

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

Status	Code	Description	Value
`400`	`ERROR_ARGUMENT`	wrong_email	`EMAIL` is not passed or an invalid e-mail is passed
`400`	`ERROR_ARGUMENT`	no_extranet_field	`UF_DEPARTMENT` is not passed for an employee and `EXTRANET` = `Y` is not passed
`400`	`ERROR_ARGUMENT`	no_sonet_group_for_extranet	`EXTRANET` = `Y` is passed, but `SONET_GROUP_ID` is not passed
`400`	`ERROR_ARGUMENT`	invalid_type_field	An array or object is passed in a text field. The field code is returned in the `argument` key of the response
`400`	`ERROR_ARGUMENT`	Could not verify Bitrix24.Network. Try again later or contact support.	The e-mail did not pass the Bitrix24.Network check
`400`	`ERROR_ARGUMENT`	A user with this email already exists	A user with this e-mail already exists in Bitrix24
`400`	`ERROR_ARGUMENT`	user_count_exceeded	The user limit of the plan is exceeded
`400`	`ERROR_CORE`	access_denied	The user does not have permission to invite employees
`400`	`ERROR_CORE`	Error text depends on the cause	Could not send the invitation via Bitrix24.Network or add the user to the group from `SONET_GROUP_ID`
`401`	`insufficient_scope`	The request requires higher privileges than provided by the access token	The application or webhook has the `user_brief` or `user_basic` scope version. The method works only in the `user` version

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?

User Scope Versions

Update User Data

Invite a user user.add

Method ParametersMethod Parameters

Code ExamplesCode Examples

Invite an EmployeeInvite an Employee

Invite an Extranet UserInvite an Extranet User

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