Set Common Detail for All Users crm.item.details.configuration.forceCommonScopeForAll

Scope: crm

Who can execute the method: Administrator

This method forcibly sets a common detail for all users, removing their personal detail configuration.

Note

The settings for repeat lead detail forms may differ from those of simple lead detail forms. The parameter extras.leadCustomerType is used to switch between lead detail form settings.
The settings for the CRM entity detail form may vary depending on their Sales Funnel. The parameters used for switching are:
- extras.categoryId — for SPAs
- extras.dealCategoryId — for deals

Method Parameters

Required parameters are marked with *

Name `type`	Description
entityTypeId* `integer`	Identifier of the system or user-defined type of CRM objects
extras `object`	Additional parameters. Possible values and their structure are described below

extras

The extras parameter depends on the CRM object.

CRM Object	Name	Description
SPA	`categoryId`	Identifier of the SPA funnel. Can be obtained using `crm.category.list`. If not specified, the default funnel identifier for this SPA is used
Deal	`dealCategoryId`	Identifier of the deal funnel. Can be obtained using `crm.category.list`. If not specified, the default funnel identifier for deals is used
Lead	`leadCustomerType`	Type of leads. Possible values: `1` — simple leads `2` — repeat leads

Code Examples

How to Use Examples in Documentation

Set a common detail for deals in the funnel with id = 9

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"entityTypeId":2,"extras":{"dealCategoryId":9}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.item.details.configuration.forceCommonScopeForAll

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"entityTypeId":2,"extras":{"dealCategoryId":9},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.item.details.configuration.forceCommonScopeForAll

try
        {
        	const response = await $b24.callMethod(
        		'crm.item.details.configuration.forceCommonScopeForAll',
        		{
        			entityTypeId: 2,
        			extras: {
        				dealCategoryId: 9,
        			},
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.item.details.configuration.forceCommonScopeForAll',
                    [
                        'entityTypeId' => 2,
                        'extras' => [
                            'dealCategoryId' => 9,
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
                return;
            }
        
            echo 'Success: ' . print_r($result->data(), true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }

BX24.callMethod(
            'crm.item.details.configuration.forceCommonScopeForAll',
            {
                entityTypeId: 2,
                extras: {
                    dealCategoryId: 9,
                },
            },
            (result) => {
                if (result.error())
                {
                    console.error(result.error());
        
                    return;
                }
        
                console.info(result.data());
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.item.details.configuration.forceCommonScopeForAll',
            [
                'entityTypeId' => 2,
                'extras' => [
                    'dealCategoryId' => 9,
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": true,
            "time": {
                "start": 1720687903.685834,
                "finish": 1720687904.076471,
                "duration": 0.3906371593475342,
                "processing": 0.02508091926574707,
                "date_start": "2024-07-11T10:51:43+02:00",
                "date_finish": "2024-07-11T10:51:44+02:00",
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `boolean`	Root element of the response. Returns `true` on success
time `time`	Information about the execution time of the request

Error Handling

HTTP Status: 400

{
            "error": "",
            "error_description": "Parameter 'entityTypeId' is not defined"
        }

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
Empty value	Parameter 'entityTypeId' is not defined	Required parameter `entityTypeId` not provided
Empty value	The entity type '`entityTypeName`' is not supported in current context.	The method does not support this entity type
Empty value	Access denied.	The user does not have administrative rights

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

Reset CRM Entity Detail Form Parameters

Widgets

Set Common Detail for All Users crm.item.details.configuration.forceCommonScopeForAll

Method ParametersMethod Parameters

extrasextras

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