Invite User user.add

Scope: user

Who can execute the method: administrator

The method user.add invites a user. This can only be done on behalf of a user with the rights to invite users, typically an administrator. Upon success, a standard invitation will be sent to the account. The result returns the identifier of the new user.

If you need to add an extranet user, you must pass the fields: EXTRANET: Y and SONET_GROUP_ID: [...]. If you need to add an intranet user, it is mandatory to pass: UF_DEPARTMENT: [...].

Method Parameters

Required parameters are marked with *

Name `type`	Description
EMAIL* `string`	User's e-mail
NAME `string`	First name
LAST_NAME `string`	Last name
SECOND_NAME `string`	Middle name
PERSONAL_GENDER `string`	Gender
PERSONAL_PROFESSION `string`	Profession
PERSONAL_WWW `string`	Personal webpage
PERSONAL_BIRTHDAY `string`	Date of birth
PERSONAL_PHOTO `array`	Photo, pass an array with the filename and a string in Base64
PERSONAL_ICQ `string`	ICQ
PERSONAL_PHONE `string`	Personal phone
PERSONAL_FAX `string`	Fax
PERSONAL_MOBILE `string`	Personal mobile
PERSONAL_PAGER `string`	Pager
PERSONAL_STREET `string`	Street address
PERSONAL_CITY `string`	City of residence
PERSONAL_STATE `string`	State/Region
PERSONAL_ZIP `string`	Zip code
PERSONAL_COUNTRY `string`	Country
PERSONAL_MAILBOX `string`	Mailbox
PERSONAL_NOTES `string`	Additional notes
WORK_PHONE `string`	Company phone
WORK_COMPANY `string`	Company
WORK_POSITION `string`	Position
WORK_DEPARTMENT `string`	Department
WORK_WWW `string`	Company website
WORK_FAX `string`	WORK_FAX
WORK_PAGER `string`	WORK_PAGER
WORK_STREET `string`	WORK_STREET
WORK_MAILBOX `string`	WORK_MAILBOX
WORK_CITY `string`	City of work
WORK_STATE `string`	WORK_STATE
WORK_ZIP `string`	WORK_ZIP
WORK_COUNTRY `string`	WORK_COUNTRY
WORK_PROFILE `string`	WORK_PROFILE
WORK_LOGO `array`	WORK_LOGO
WORK_NOTES `string`	WORK_NOTES
UF_SKYPE_LINK `string`	Skype chat link
UF_ZOOM `string`	Zoom
UF_DEPARTMENT `string`	Departments
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`	Skype
UF_DISTRICT `string`	District
UF_PHONE_INNER `string`	Internal phone

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

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

try
        {
        	const response = await $b24.callMethod(
        		'user.add',
        		{
        			'EMAIL': 'newuser1@example.com',
        			'UF_DEPARTMENT': [1]
        		}
        	);
        	
        	const result = response.getData().result;
        	console.dir(result);
        }
        catch( error )
        {
        	console.error('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>';

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`	Identifier of the new user
time `time`	Information about the request execution time

Error Handling

HTTP Status: 400

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

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	Error Message	Description
`ERROR_ARGUMENT`	wrong_email	The `EMAIL` parameter is missing or an incorrect e-mail is provided
`ERROR_ARGUMENT`	User with this email already exists	Attempt to register a user with an email that is already taken
`ERROR_CORE`	access_denied	The user does not have permission to call the method
`ERROR_ARGUMENT`	user_count_exceeded	The number of users has been exceeded
`ERROR_GROUPID`	Group code not specified	Group code not specified when adding a user to the extranet
`ERROR_NO_GROUP`	Group specified incorrectly	Incorrect group specified when adding a user
`ERROR_ARGUMENT`	no_extranet_field	The method call did not specify which group the user should belong to
`ERROR_CORE`		Error updating user fields

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 allowed to be called 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 methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks 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 account administrator has allowed access to this application only for specific users
`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 option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

User Scope Versions

Update User Data

Invite User user.add

Method ParametersMethod Parameters

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