Client Details Autofill in the CRM Card CRM_REQUISITE_AUTOCOMPLETE

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: placement, crm

The CRM_REQUISITE_AUTOCOMPLETE point connects an application handler to the search for client details in a CRM card. It is required when an application searches for and populates Company details for a company or contact from an external source.

The embedding point code is passed in the PLACEMENT parameter of the placement.bind method.

The general workflow is described in the Autofilling details in the CRM card overview.

The handler will not be available in the search source selection interface until the application installation is complete. Check the application installation

Where the Widget Is Embedded

Embedding Point Code

Location

CRM_REQUISITE_AUTOCOMPLETE

Search source in the Details field of a company or contact card

Where to Find It in the Interface

Open a company or contact card and go to the Details field. The handler is connected to the search in this field.

If only one search source is available, its name is shown as a hint inside the field. If there are several sources, they are offered in a list below the field as you type a query. The application handler appears in this list under the name from the TITLE parameter.

Application handler in the list of details search sources

What the Handler Receives

Data is sent in a POST request: some parameters come in the handler URL query string, the rest in the request body

Array
        (
            [DOMAIN] => xxx.bitrix24.com
            [PROTOCOL] => 1
            [LANG] => en
            [APP_SID] => 8b3f2c5d9c1a4f6e9d7a2b4c6f8e1a3d
            [AUTH_ID] => 1f0f107e5806d5fe9a98e02021a72e57645f86a
            [AUTH_EXPIRES] => 3600
            [REFRESH_ID] => 1f0f107a80816604b24a8719792ac2a21d629b5
            [SERVER_ENDPOINT] => https://oauth.bitrix.info/rest/
            [APPLICATION_TOKEN] => ec1b2074a9d3f5c81b6e40d27a95cf38
            [APPLICATION_SCOPE] => crm,placement
            [member_id] => da45a03b265edd8787f8a258d793cc5d
            [status] => L
            [PLACEMENT] => CRM_REQUISITE_AUTOCOMPLETE
            [PLACEMENT_OPTIONS] => {"searchQuery":"Daisy","URI":"\/crm\/company\/details\/7\/?any=details%2F7%2F&IFRAME=Y&IFRAME_TYPE=SIDE_SLIDER"}
        )
        

After parsing, the PLACEMENT_OPTIONS string from this example looks like this:

{
            "searchQuery": "Daisy",
            "URI": "/crm/company/details/7/?any=details%2F7%2F&IFRAME=Y&IFRAME_TYPE=SIDE_SLIDER"
        }
        

Parameters in the Handler URL Query String

Parameter
type

Description

DOMAIN*
string

The Bitrix24 address where the widget handler was invoked

PROTOCOL*
string

Secure or non-secure HTTP protocol:

  • 0 - HTTP
  • 1 - HTTPS

LANG*
string

The user interface language of Bitrix24 that invoked the widget. You can localize the interface language in your widget based on this value

APP_SID*
string

Application session identifier. Bitrix24 generates a new one each time the widget is rendered and uses it to link the js library with the application environment

Parameters in the POST Request Body

Parameter
type

Description

AUTH_ID
string

Authorization token OAuth 2 issued for the user who invoked the widget. Can be used for REST API calls on behalf of this user

AUTH_EXPIRES
integer

Time in seconds after which the authorization token will become invalid

REFRESH_ID
string

Refresh token OAuth 2 issued for the user who invoked the widget. Can be used to refresh the authorization token on behalf of this user

SERVER_ENDPOINT*
string

Address of the Bitrix24 authorization server needed to refresh OAuth 2 tokens

APPLICATION_TOKEN*
string

Application token. The same value is passed in the application_token parameter when event handlers are invoked. The widget handler can use it to verify that the request came from Bitrix24

APPLICATION_SCOPE*
string

List of scopes granted to the application, separated by commas. Shows which REST API methods are available with the authorization token received

member_id*
string

Unique string identifier of Bitrix24 where the widget handler was invoked.

status
string

Type of application that registered the handler for this widget. Accepts values:

  • L - local application
  • F - free mass-market application
  • D - demo version of a mass-market application
  • T - trial version of a mass-market application, time-limited
  • P - paid mass-market application

PLACEMENT*
string

The placement code. You can use the same handler URL for all your widgets. The value that Bitrix24 will report in the PLACEMENT parameter will help determine from which specific placement your handler was invoked in each case

PLACEMENT_OPTIONS
string

Additional data in the form of a JSON string that defines the context of the widget execution. For example, this could be an array containing the numeric identifier of the CRM object in the detail form where the widget handler was invoked, etc. The PLACEMENT_OPTIONS parameter, along with the PLACEMENT parameter, allows you to accurately determine for which specific placement and object the widget handler was invoked

Bitrix24 adds a URI key to PLACEMENT_OPTIONS — the path with the query string of the page from which the widget was opened. It arrives for any placement, along with the keys of that placement itself. The key is absent if the browser did not send the Referer header or if the widget was opened from a page on a different domain.

How to Parse the Call Context

PLACEMENT_OPTIONS arrives as a JSON string, not as an array: parse it on the handler side before use. The set of keys is specific to each placement and is described in the PLACEMENT_OPTIONS section of this page.

$placement = $_POST['PLACEMENT'] ?? '';
        $options = json_decode($_POST['PLACEMENT_OPTIONS'] ?? '{}', true);
        
options = json.loads(request.form.get("PLACEMENT_OPTIONS", "{}") or "{}")
        

In B24JsSDK, there is no need to parse the string: the $b24.placement.options property returns a ready object, and $b24.placement.placement returns the placement code.

What the Handler Must Return

The handler responds with a regular HTML page — Bitrix24 displays it in a frame in place of the widget. The page must allow embedding: if the application server sends the X-Frame-Options or Content-Security-Policy headers that prohibit framing, an empty area remains in place of the widget. How to fix it is described in the article Site Does Not Allow Connection.

PLACEMENT_OPTIONS

The value of PLACEMENT_OPTIONS is passed as a JSON string with the context of the call. Along with the universal URI key, the context carries the key of the placement itself.

Required parameters are marked with *

Parameter

Description

searchQuery*
string

The string that the user entered in the details search field

OPTIONS When Registering via placement.bind

The placement supports the OPTIONS parameter of the placement.bind method. It restricts the list of countries the handler works for and is not included in the data that Bitrix24 passes to the handler during a search.

Parameter
type

Description

countries
string

Country identifiers separated by commas without spaces. If the parameter is not passed, the handler is available to all countries for which the search field is open.

Country identifiers can be obtained via the crm.requisite.preset.countries

How to Return Found Options

Pass the found options using the BX24.placement.call command with the name crmShowFoundEntities.

Field
type

Description

data
array

List of found options

data[].id
string

Option identifier on the application side

data[].name
string

Option name that will be shown to the user

data[].phone
string

Option phone. Pass the field if the number is found

data[].email
string

Option E-mail. Pass the field if the address is found

data[].web
string

Option website. Pass the field if the website is found

BX24.placement.call(
            'crmShowFoundEntities',
            {
                data: [
                    {
                        id: 'company-123',
                        name: 'Acme LLC',
                        phone: '+49 30 000-00-00',
                        email: 'info@example.com',
                        web: 'https://example.com'
                    }
                ]
            }
        );
        

How to Fill the Selected Option Into the Card

If a user selects an option from the application response, Bitrix24 triggers the onCrmEntityIsNeedToCreate interface event. Subscribe to it using the BX24.placement.bindEvent method.

The data of the selected option is passed to the onCrmEntityIsNeedToCreate event handler.

Field
type

Description

appSid
string

Application session identifier in which the selected option was found

data
object

Data of the selected option from the list that the application passed via crmShowFoundEntities

In the fields object, pass the detail fields that should be populated in the CRM card. The composition of the object depends on the data that the application retrieved from its source.

BX24.placement.bindEvent('onCrmEntityIsNeedToCreate', function (eventData) {
            const selected = eventData.data;
            const selectedTitle = selected.title || selected.name;
        
            BX24.placement.call(
                'crmShowCreatedEntity',
                {
                    entityType: 'company',
                    id: selected.id,
                    title: selectedTitle,
                    fields: {
                        RQ_COMPANY_NAME: selectedTitle
                    }
                }
            );
        });
        

Fields of the crmShowCreatedEntity command:

Field
type

Description

entityType
string

Created object type. For a company, pass company, for a contact — contact

id
string

Created object identifier on the application side

title
string

Created object name

fields
object

Requisite fields to be inserted into the CRM card

Code Examples

How to Use Examples in Documentation

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
            "PLACEMENT": "CRM_REQUISITE_AUTOCOMPLETE",
            "HANDLER": "https://your-domain.com/widgets/crm-requisite-autocomplete-handler.php",
            "TITLE": "Requisite search",
            "LANG_ALL": {
              "de": {
                "TITLE": "Requisite search"
              },
              "en": {
                "TITLE": "Requisite search"
              }
            },
            "OPTIONS": {
              "countries": "1,14"
            },
            "auth": "**put_access_token_here**"
          }' \
          https://**put_your_bitrix24_address**/rest/placement.bind
        
// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        try {
          const response = await $b24.actions.v2.call.make<boolean>({
            method: 'placement.bind',
            params: {
              PLACEMENT: 'CRM_REQUISITE_AUTOCOMPLETE',
              HANDLER: 'https://your-domain.com/widgets/crm-requisite-autocomplete-handler.php',
              TITLE: 'Requisite search',
              LANG_ALL: {
                de: {
                  TITLE: 'Requisite search',
                },
                en: {
                  TITLE: 'Requisite search',
                },
              },
              OPTIONS: {
                countries: '1,14',
              },
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Placement bound successfully:', result)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function bindCrmRequisiteAutocomplete() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'placement.bind',
                params: {
                  PLACEMENT: 'CRM_REQUISITE_AUTOCOMPLETE',
                  HANDLER: 'https://your-domain.com/widgets/crm-requisite-autocomplete-handler.php',
                  TITLE: 'Requisite search',
                  LANG_ALL: {
                    de: {
                      TITLE: 'Requisite search',
                    },
                    en: {
                      TITLE: 'Requisite search',
                    },
                  },
                  OPTIONS: {
                    countries: '1,14',
                  },
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Placement bound successfully:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', bindCrmRequisiteAutocomplete)
        </script>
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'placement.bind',
                    [
                        'PLACEMENT' => 'CRM_REQUISITE_AUTOCOMPLETE',
                        'HANDLER' => 'https://your-domain.com/widgets/crm-requisite-autocomplete-handler.php',
                        'TITLE' => 'Requisite search',
                        'LANG_ALL' => [
                            'de' => [
                                'TITLE' => 'Requisite search',
                            ],
                            'en' => [
                                'TITLE' => 'Requisite search',
                            ],
                        ],
                        'OPTIONS' => [
                            'countries' => '1,14',
                        ],
                    ]
                );
        
            $result = $response->getResponseData()->getResult();
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error binding placement: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'placement.bind',
            {
                PLACEMENT: 'CRM_REQUISITE_AUTOCOMPLETE',
                HANDLER: 'https://your-domain.com/widgets/crm-requisite-autocomplete-handler.php',
                TITLE: 'Requisite search',
                LANG_ALL: {
                    de: { TITLE: 'Requisite search' },
                    en: { TITLE: 'Requisite search' }
                },
                OPTIONS: {
                    countries: '1,14'
                }
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'placement.bind',
            [
                'PLACEMENT' => 'CRM_REQUISITE_AUTOCOMPLETE',
                'HANDLER' => 'https://your-domain.com/widgets/crm-requisite-autocomplete-handler.php',
                'TITLE' => 'Requisite search',
                'LANG_ALL' => [
                    'de' => [
                        'TITLE' => 'Requisite search',
                    ],
                    'en' => [
                        'TITLE' => 'Requisite search',
                    ],
                ],
                'OPTIONS' => [
                    'countries' => '1,14',
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "placement.bind", b24.Params{
        	"PLACEMENT": "CRM_REQUISITE_AUTOCOMPLETE",
        	"HANDLER":   "https://your-domain.com/widgets/crm-requisite-autocomplete-handler.php",
        	"TITLE":     "Requisite search",
        	"LANG_ALL": b24.Params{
        		"de": b24.Params{
        			"TITLE": "Requisite search",
        		},
        		"en": b24.Params{
        			"TITLE": "Requisite search",
        		},
        	},
        	"OPTIONS": b24.Params{
        		"countries": "1,14",
        	},
        })
        if err != nil {
        	return fmt.Errorf("placement.bind: %w", err)
        }
        
        // The response arrives as json.RawMessage — unmarshal it into the response
        // shape of the placement.bind method, see "Response Handling" on its page.
        fmt.Printf("%s\n", res.Result)
        

Common Mistakes

Mistake

Solution

placement.bind returns WRONG_AUTH_TYPE with the description Application context required

Register the placement on behalf of an application. A placement cannot be bound with a webhook

The handler is registered but does not appear in the list of search sources

Complete the application installation and check that the CRM_REQUISITE_AUTOCOMPLETE code is passed in PLACEMENT

The handler is unavailable for the required country

Check the value of OPTIONS[countries]. The string must contain country identifiers separated by commas without spaces

The handler is not called while the user is typing the query

Bitrix24 calls the external search when the search string contains at least three characters

The handler does not find the search string in the request body

searchQuery arrives inside PLACEMENT_OPTIONS as a separate JSON string, not as a separate parameter

Found options are not displayed

Pass the array of options to the data field of the crmShowFoundEntities command

The option is not filled into the card after selection

Subscribe to onCrmEntityIsNeedToCreate and call crmShowCreatedEntity after creating the object

Other registration error codes are listed in the "Possible Error Codes" section of the placement.bind page.

Continue Learning