Invite users to group sonet_group.user.invite

Scope: sonet

Who can perform the method: a user with the permission to Invite to a group or project

The method sonet_group.user.invite sends invitations to users in a workgroup or project.

Method parameters

Required parameters are marked with *

Name `type`	Description
GROUP_ID* `integer`	Identifier of the workgroup or project. The identifier can be obtained using the sonet_group.get method.
USER_ID* `integer/array`	User identifier. The identifier can be obtained using the user.get method.
MESSAGE `string`	Invitation text.

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 '{"GROUP_ID":69,"USER_ID":1271,"MESSAGE":"Join the project"}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sonet_group.user.invite

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"GROUP_ID":69,"USER_ID":1271,"MESSAGE":"Join the project","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sonet_group.user.invite

try
        {
            const response = await $b24.callMethod(
                'sonet_group.user.invite',
                {
                    GROUP_ID: 69,
                    USER_ID: 1271,
                    MESSAGE: 'Join the project',
                }
            );
            
            const result = response.getData().result;
            console.log('User invited to group:', result);
            
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'sonet_group.user.invite',
                    [
                        'GROUP_ID' => 69,
                        'USER_ID' => 1271,
                        'MESSAGE' => 'Join the project'
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error inviting user to group: ' . $e->getMessage();
        }

BX24.callMethod(
            'sonet_group.user.invite',
            {
                GROUP_ID: 69,
                USER_ID: 1271,
                MESSAGE: 'Join the project'
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error(), result.error_description());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'sonet_group.user.invite',
            [
                'GROUP_ID' => 69,
                'USER_ID' => 1271,
                'MESSAGE' => 'Join the project'
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response handling

HTTP status: 200

{
            "result": ["1271"],
            "time": {
                "start": 1773846932,
                "finish": 1773846933.077318,
                "duration": 1.0773179531097412,
                "processing": 0,
                "date_start": "2026-03-18T18:15:32+02:00",
                "date_finish": "2026-03-18T18:15:33+02:00",
                "operating_reset_at": 1773847533,
                "operating": 0
            }
        }

Returned data

Name
type

Description

result
array

An array of user identifiers that were successfully invited.

An empty array means that none of the provided users could be invited. For example, the user is already a member of the group or the current user does not have permission to invite.

time
time

Information about the request execution time.

Error handling

HTTP status: 400

{
            "error": "",
            "error_description": "Wrong user IDs"
        }

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	Value
—	`Wrong group ID`	An incorrect `GROUP_ID` was provided.
—	`Wrong user IDs`	An empty or incorrect `USER_ID` was provided.
—	`Socialnetwork group not found`	The group or project was not found or is not accessible to the current user.

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 exploring

Overview of Methods

Send a Participation Request from the Current User

Invite users to group sonet_group.user.invite

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 exploringContinue exploring