Сбросить параметры карточки crm.contact.details.configuration.reset

Scope: crm

Кто может выполнять метод:

• любой пользователь может сбросить свои личные настройки
• пользователь с правом «Разрешить изменять настройки» в CRM может сбросить общие и чужие личные настройки

Метод сбрасывает настройки карточки контактов: удаляет личные настройки карточки указанного пользователя или общие настройки, заданные для всех пользователей.

Параметры методаПараметры метода

Обязательные параметры отмечены *

Примеры кодаПримеры кода

Как использовать примеры в документации

1. Сбросить общую конфигурацию

   cURL (Webhook)

   cURL (OAuth)

   BX24.js

   PHP

   Go

   curl -X POST \
   -H "Content-Type: application/json" \
   -H "Accept: application/json" \
   -d '{"scope":"C"}' \
   https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.contact.details.configuration.reset
   

   curl -X POST \
   -H "Content-Type: application/json" \
   -H "Accept: application/json" \
   -d '{"scope":"C","auth":"**put_access_token_here**"}' \
   https://**put_your_bitrix24_address**/rest/crm.contact.details.configuration.reset
   

   BX24.callMethod(
       'crm.contact.details.configuration.reset',
       {
           scope: "C",
       },
       (result) => {
           result.error()
               ? console.error(result.error())
               : console.info(result.data())
           ;
       },
   );
   

   require_once('crest.php');
   
   $result = CRest::call(
       'crm.contact.details.configuration.reset',
       [
           'scope' => 'C'
       ]
   );
   
   echo '<PRE>';
   print_r($result);
   echo '</PRE>';
   

   // client и ctx уже созданы — см. раздел «SDK для Go»
   res, err := client.Core().Call(ctx, "crm.contact.details.configuration.reset", b24.Params{
   	"scope": "C",
   })
   if err != nil {
   	return fmt.Errorf("crm.contact.details.configuration.reset: %w", err)
   }
   
   var ok bool
   if err := json.Unmarshal(res.Result, &ok); err != nil {
   	return fmt.Errorf("разбор ответа: %w", err)
   }
   fmt.Println("выполнено:", ok)
   

2. Сбросить личную конфигурацию

   cURL (Webhook)

   cURL (OAuth)

   BX24.js

   PHP

   Python

   Go

   curl -X POST \
   -H "Content-Type: application/json" \
   -H "Accept: application/json" \
   -d '{"scope":"P","userId":6}' \
   https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.contact.details.configuration.reset
   

   curl -X POST \
   -H "Content-Type: application/json" \
   -H "Accept: application/json" \
   -d '{"scope":"P","userId":6,"auth":"**put_access_token_here**"}' \
   https://**put_your_bitrix24_address**/rest/crm.contact.details.configuration.reset
   

   BX24.callMethod(
       'crm.contact.details.configuration.reset',
       {
           scope: "P",
           userId: 6,
       },
       (result) => {
           result.error()
               ? console.error(result.error())
               : console.info(result.data())
           ;
       },
   );
   

   require_once('crest.php');
   
   $result = CRest::call(
       'crm.contact.details.configuration.reset',
       [
           'scope' => 'P',
           'userId' => 6
       ]
   );
   
   echo '<PRE>';
   print_r($result);
   echo '</PRE>';
   

   from b24pysdk.errors import BitrixAPIError, BitrixSDKException
   
   try:
       bitrix_response = client.crm.contact.details.configuration.reset(
           scope="P",
           user_id=6,
       ).response
       result = bitrix_response.result
       print(result)
   except BitrixAPIError as error:
       print(
           "Ошибка Bitrix API",
           f"error: {error.error}",
           f"error_description: {error.error_description}",
           sep="\n",
       )
   except BitrixSDKException as error:
       print(f"Ошибка Bitrix SDK: {error.message}")
   except Exception as error:
       print(f"Непредвиденная ошибка: {error}")
   

   // client и ctx уже созданы — см. раздел «SDK для Go»
   res, err := client.Core().Call(ctx, "crm.contact.details.configuration.reset", b24.Params{
   	"scope":  "P",
   	"userId": 6,
   })
   if err != nil {
   	return fmt.Errorf("crm.contact.details.configuration.reset: %w", err)
   }
   
   var ok bool
   if err := json.Unmarshal(res.Result, &ok); err != nil {
   	return fmt.Errorf("разбор ответа: %w", err)
   }
   fmt.Println("выполнено:", ok)
   

Обработка ответаОбработка ответа

HTTP-статус: 200

{
    "result": true,
    "time": {
        "start": 1724682584.069094,
        "finish": 1724682584.38436,
        "duration": 0.31526613235473633,
        "processing": 0.025727033615112305,
        "date_start": "2024-08-26T16:29:44+02:00",
        "date_finish": "2024-08-26T16:29:44+02:00",
        "operating": 0
    }
}

Возвращаемые данныеВозвращаемые данные

Обработка ошибокОбработка ошибок

HTTP-статус: 400

{
    "error": "",
    "error_description": "Access denied."
}

Возможные коды ошибокВозможные коды ошибок

Статусы и коды системных ошибокСтатусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Продолжите изучениеПродолжите изучение

• Управление карточками контактов: обзор методов
• Получить параметры карточки crm.contact.details.configuration.get
• Установить параметры индивидуальной карточки crm.contact.details.configuration.set
• Установить общую карточку для всех пользователей crm.contact.details.configuration.forceCommonScopeForAll