Open Path in the Slider BX24.openPath

We are still updating this page

Some data may be missing here — we will complete it shortly.

The method BX24.openPath opens the specified path within the account in the slider.

Warning

For security reasons, the method does not work in the mobile application.

Note

Starting from version 22.300, it can open SPAs.

Parameters

Parameter

Description

Available since

path
unknown

The path within the account, which can start with:

^\/(crm\/(deal|lead|contact|company|type)|marketplace|company\/personal\/user\/[0-9]+|workgroups\/group\/[0-9]+)\/

callback
unknown

The function is called in 2 cases:

  • when there is an error opening
  • if the specified path cannot be opened: {result: "error", errorCode: "PATH_NOT_AVAILABLE"}
  • in the mobile application: {result: "error", errorCode: "METHOD_NOT_SUPPORTED_ON_DEVICE"}
  • when the slide is closed: {result: "close"}

Example:

<script src="//api.bitrix24.com/api/v1/"></script>
        <script>
            BX24.init(
                function()
                {
                    BX24.openPath(
                        '/crm/deal/details/5/',
                        function(result)
                        {
                            console.log(result);
                        }
                    );
                }
            );
        </script>

How to Use Examples in Documentation

Previous
Open Popup Window
Next
Get Context Link