Make a Linked Contact Primary v 3.0 crm.[type].setprimarycontact

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: crm

Who can execute the method: a user with permission to edit items of this CRM object type

This method belongs to REST 3.0. The call specifics and response format of the new API version are described in the REST 3.0 overview.

The crm.<type>.setprimarycontact method makes one of the contacts already linked to a CRM item the primary contact. The object type is set by the <type> segment of the method name.

The primary contact is the one whose ID the item returns in the contactId field. All linked contacts are listed in the contactsId field. The method does not link a new contact: first add it with the crm.<type>.addfieldvalue method using the contactsId field.

Method Name for the Object Type

Object type

Method

Fields

Deal

crm.deal.setprimarycontact

Deal fields

Lead

crm.lead.setprimarycontact

Lead fields

Estimate

crm.quote.setprimarycontact

Estimate fields

Invoice

crm.smartinvoice.setprimarycontact

Invoice fields

CRM document

crm.smartdocument.setprimarycontact

—

B2E document

crm.smartb2edocument.setprimarycontact

—

SPA

crm.smartprocess<entityTypeId>.setprimarycontact, for example, crm.smartprocess1038.setprimarycontact

SPA fields

For an SPA, the method name includes the type ID entityTypeId. SPA type IDs are returned by the crm.type.list method in the entityTypeId field.

The method name is written in lowercase: crm.smartinvoice.setprimarycontact, not crm.smartInvoice.setprimarycontact. If the name is written in a different case, the method returns the "Method Not Found" error.

An SPA has this method only if client linking is enabled for its type. Otherwise, the call returns the "Method Not Found" error with status 404. Contacts, companies, and my companies do not have this method.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
integer

Item ID. Item IDs can be retrieved with the crm.<type>.list method

contactId*
integer

ID of the contact to make primary. The contact must be in the contactsId field of the item. Linked contacts are returned by the crm.<type>.get method

If the contact is already primary, the method returns true and changes nothing. The method does not change the order of contacts in contactsId.

Code Examples

How to Use Examples in Documentation

The new API call differs by adding the /api/ segment to the request URL:

https://{installation_address}/rest/api/{user_id}/{webhook_token}/crm.smartprocess1038.setprimarycontact

The examples make contact 3215 the primary contact of an SPA item with the type ID 1038. For a different object type, replace the method name according to the table above.

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":27,"contactId":3215}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.smartprocess1038.setprimarycontact
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":27,"contactId":3215,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/crm.smartprocess1038.setprimarycontact
        

CRM methods are not yet included in the list of REST 3.0 methods known to $b24.actions.v3.call.make: such a call returns the SDK error JSSDK_CORE_METHOD_NOT_SUPPORT_IN_API_V3. Call the method through the REST 3.0 HTTP client — $b24.getHttpClient(ApiVersion.v3).call.

import { ApiVersion, Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type SetPrimaryContactResult = {
          result: boolean
        }
        
        try {
          const response = await $b24.getHttpClient(ApiVersion.v3).call<SetPrimaryContactResult>(
            'crm.smartprocess1038.setprimarycontact',
            {
              id: 27,
              contactId: 3215,
            },
            Text.getUuidRfc4122()
          )
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Primary contact set:', result.result)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        

CRM methods are not yet included in the list of REST 3.0 methods known to $b24.actions.v3.call.make. Call the method through the REST 3.0 HTTP client — $b24.getHttpClient(B24Js.ApiVersion.v3).call.

<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function setPrimaryContact() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.getHttpClient(B24Js.ApiVersion.v3).call(
                'crm.smartprocess1038.setprimarycontact',
                {
                  id: 27,
                  contactId: 3215,
                },
                B24Js.Text.getUuidRfc4122()
              )
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Primary contact set:', result.result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', setPrimaryContact)
        </script>
        

b24pysdk has no ready-made wrappers for CRM methods, and the SDK sends to REST 3.0 only the methods from the Config().api_v3_methods list. Add the method to this list and call it via bitrix_token.call_method with prefer_version=3.

from b24pysdk import Config
        from b24pysdk.errors import BitrixSDKException
        from b24pysdk.errors.v3 import BitrixAPIError
        
        method = "crm.smartprocess1038.setprimarycontact"
        Config().configure(api_v3_methods=Config().api_v3_methods | {method})
        
        try:
            response = bitrix_token.call_method(
                api_method=method,
                params={
                    "id": 27,
                    "contactId": 3215,
                },
                prefer_version=3,
            )
            result = response["result"]
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"code: {error.code}",
                f"message: {error.error.message}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.smartprocess1038.setprimarycontact',
                    [
                        'id' => 27,
                        'contactId' => 3215,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }
        

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.

BX24.callMethod(
            'crm.smartprocess1038.setprimarycontact',
            {
                id: 27,
                contactId: 3215,
            },
            result => {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.

require_once('crest.php');
        
        $result = CRest::call(
            'crm.smartprocess1038.setprimarycontact',
            [
                'id' => 27,
                'contactId' => 3215,
            ]
        );
        
        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.smartprocess1038.setprimarycontact", b24.Params{
        	"id":        27,
        	"contactId": 3215,
        })
        if err != nil {
        	return fmt.Errorf("crm.smartprocess1038.setprimarycontact: %w", err)
        }
        
        var updated struct {
        	Result bool `json:"result"`
        }
        if err := json.Unmarshal(res.Result, &updated); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(updated.Result)
        

Response Handling

HTTP status: 200

{
            "result": {
                "result": true
            },
            "time": {
                "start": 1793706737,
                "finish": 1793706737.554163,
                "duration": 0.5541629791259766,
                "processing": 0,
                "date_start": "2026-11-03T14:52:17+03:00",
                "date_finish": "2026-11-03T14:52:17+03:00",
                "operating_reset_at": 1793707320,
                "operating": 0.17444896697998047
            }
        }
        

Returned Data

Name
type

Description

result
object

Object with response data

result.result
boolean

true if the contact is primary. The primary contact ID can be retrieved with the crm.<type>.get method in the contactId field

time
time

Information about the request execution time

Error Handling

HTTP status: 400

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
                "message": "Error validating request object.",
                "validation": [
                    {
                        "message": "The contact is not bound to the item.",
                        "field": "CONTACT_NOT_BOUND"
                    }
                ]
            }
        }
        

Name
type

Description

error.code
string

String error code. Use it to identify the type of exception

error.message
string

Text description of the error

error.validation
array

Array with error details. Present only in data validation errors BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

error.validation[].field
string

Name of the field where the validation error occurred

error.validation[].message
string

Description of the error related to the specified field

Possible Error Codes

Item Not Found

Error Code: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION

Field

Error description

How to Fix

-

Entity with ID #ID# was not found

Check the item ID. This object type has no item with this id, or the item has been deleted

Request Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Field

Error description

How to Fix

id

Required field id is missing

Pass the item id

contactId

Required field contactId is missing

Pass the contact ID

contactId

Field value must be 1 or greater

Pass a positive ID

contactId

This request requires data type int in field contactId

Pass the ID as a number

CONTACT_NOT_BOUND

The contact is not bound to the item

The contact is not linked to the item. Link it with the crm.<type>.addfieldvalue method using the contactsId field

CONTACT_NOT_FOUND

The contact does not exist

There is no contact with this ID. Check contactId

In the CONTACT_NOT_BOUND and CONTACT_NOT_FOUND errors, the field key contains the error code instead of a field name.

Method Not Found

Error Code: BITRIX_REST_V3_EXCEPTION_METHODNOTFOUNDEXCEPTION, HTTP status: 404

Field

Error description

How to Fix

-

Method #METHOD# was not found

Check the method name: it is written in lowercase, for example, crm.deal.setprimarycontact. For an SPA, check entityTypeId with the crm.type.list method

Statuses 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.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning