Documentation

crm.lead.details.configuration.get

The method gets configuration parameters for lead details. Leads personal configuration for specified user details or general configuration, specified for all users.

Note that repeat leads can differ from common lead details. Use the parameter leadCustomerType to switch between configurations of lead details.

Parameters

Parameter Description Available from version
scope Configuration scope of application. Available values:
  • P - personal configuration,
  • C - general configuration
userId User ID. Indicates current ID if not set. Only required when getting personal configuration.
extras Extra parameters. leadCustomerType parameter for deals can be specified here with values as follows:
  • 1 - coming leads,
  • 2 - repeat leads

Example

//--
//Get personal configuration for lead details for user with identifier 1.
BX24.callMethod(
    "crm.lead.details.configuration.get",
    {
        scope: "P",
        userId: 1
    },
    function(result)
    {
        if(result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);
//Get general configuration for lead details.
BX24.callMethod(
    "crm.lead.details.configuration.get",
    {
        scope: "C"
    },
    function(result)
    {
        if(result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);
//Get general configuration for repeat leads.
BX24.callMethod(
    "crm.lead.details.configuration.get",
    {
        scope: "C",
        extras: { leadCustomerType: 2 }
    },
    function(result)
    {
        if(result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);
//--


© «Bitrix Inc.», 2001-2020, «Bitrix Inc.», 2020