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

Scope: crm

Who can execute the method:

• Any user has the right to retrieve their own and common settings
• Only an administrator has the right to retrieve others' settings

This method resets the contact card settings: it removes the personal settings of the specified user or the common settings defined for all users.

Method ParametersMethod Parameters

Required parameters are marked with *

Code ExamplesCode Examples

How to Use Examples in Documentation

1. Reset Common Configuration

   cURL (Webhook)

   cURL (OAuth)

   JS

   PHP

   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>';
           

2. Reset Personal Configuration

   cURL (Webhook)

   cURL (OAuth)

   JS

   PHP

   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>';
           

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: 20x, 40x, 50x

The errors described below may occur when calling any method.

Continue LearningContinue Learning

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