Reset Card Parameters crm.contact.details.configuration.reset

Scope: crm

Who can execute the method:

• any user can reset their own personal settings
• a user with the "Allow to change settings" access permission in CRM can reset the shared settings and another user's personal settings

The method resets the contact card configurations: it removes the personal card settings of a specified user or the shared settings defined for all users.

Method ParametersMethod Parameters

Required parameters are marked with *

Code ExamplesCode Examples

How to Use Examples in Documentation

1. Reset Shared Configuration

   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 and ctx are already created — see the Go SDK section
           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("parse response: %w", err)
           }
           fmt.Println("done:", ok)
           

2. Reset Personal Configuration

   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 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}")
           

   // client and ctx are already created — see the Go SDK section
           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("parse response: %w", err)
           }
           fmt.Println("done:", ok)
           

Response HandlingResponse Handling

HTTP status: 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
            }
        }
        

Returned DataReturned Data

Error HandlingError Handling

HTTP status: 400

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

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses 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.

Continue LearningContinue Learning

• Managing Contact Cards: Overview of Methods
• Get Card Parameters crm.contact.details.configuration.get
• Set Parameters for the Individual Card crm.contact.details.configuration.set
• Set a Common Contact Card for All Users crm.contact.details.configuration.forceCommonScopeForAll