Validate a CRM Form Configuration crm.form.validate

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 CRM forms

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.form.validate method validates a CRM form configuration without saving it and returns all violations at once.

Method Parameters

Name
type

Description

id
integer

Identifier of a saved form.

The identifier can be obtained using the crm.form.list method

fields
object

Form configuration in the same format as in crm.form.add and crm.form.update. The fields are described in the CRM Form Structure section.

If id is passed, the active field cannot be specified, just as in crm.form.update

Pass at least one parameter: id or fields. The combination determines what the method validates:

  • only fields — the configuration of a new form, the way crm.form.add validates it
  • only id — the saved form in its current state
  • id and fields — changes applied on top of the saved form, the way crm.form.update validates them

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.form.validate

The example validates the configuration of a new form that has no name and specifies a nonexistent CRM scheme.

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"crm":{"entityScheme":999}}}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.form.validate
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"crm":{"entityScheme":999}},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/crm.form.validate
        
// 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
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type FormValidateResult = {
          valid: boolean
          violations: Array<{
            field: string
            message: string
          }>
        }
        
        try {
          const response = await $b24.actions.v3.call.make<FormValidateResult>({
            method: 'crm.form.validate',
            params: {
              fields: {
                crm: {
                  entityScheme: 999,
                },
              },
            },
            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(result.valid, result.violations)
          }
        } 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 validateForm() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v3.call.make({
                method: 'crm.form.validate',
                params: {
                  fields: {
                    crm: {
                      entityScheme: 999,
                    },
                  },
                },
                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(result.valid, result.violations)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', validateForm)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        # client = Client(token, prefer_version=3)
        
        try:
            bitrix_response = client.crm.form.validate(
                fields={
                    "crm": {
                        "entityScheme": 999,
                    },
                },
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                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.form.validate',
                    [
                        'fields' => [
                            'crm' => [
                                'entityScheme' => 999,
                            ],
                        ],
                    ]
                );
        
            $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: ' . $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.form.validate',
            {
              fields: {
                crm: {
                  entityScheme: 999,
                },
              },
            },
            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.form.validate',
            [
                'fields' => [
                    'crm' => [
                        'entityScheme' => 999,
                    ],
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client and ctx are already created; the client's base URL contains /rest/api/
        res, err := client.Core().Call(ctx, "crm.form.validate", b24.Params{
        	"fields": map[string]any{
        		"crm": map[string]any{
        			"entityScheme": 999,
        		},
        	},
        })
        if err != nil {
        	return fmt.Errorf("crm.form.validate: %w", err)
        }
        
        var data struct {
        	Valid      bool `json:"valid"`
        	Violations []struct {
        		Field   string `json:"field"`
        		Message string `json:"message"`
        	} `json:"violations"`
        }
        if err := json.Unmarshal(res.Result, &data); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(data.Valid, data.Violations)
        

Response Handling

HTTP status: 200

{
            "result": {
                "valid": false,
                "violations": [
                    {
                        "field": "name",
                        "message": "Name of the CRM form is required"
                    },
                    {
                        "field": "crm.entityScheme",
                        "message": "CRM scheme of the form can not be used"
                    }
                ]
            },
            "time": {
                "start": 1792593823,
                "finish": 1792593823.067024,
                "duration": 0.06702399253845215,
                "processing": 0,
                "date_start": "2026-10-21T17:43:43+02:00",
                "date_finish": "2026-10-21T17:43:43+02:00",
                "operating_reset_at": 1792594380,
                "operating": 0
            }
        }
        

If there are no violations:

{
            "result": {
                "valid": true,
                "violations": []
            }
        }
        

Configuration violations are not treated as a request error: the method responds with HTTP status 200 and lists the violations in violations.

Returned Data

Name
type

Description

result
object

Object with the validation result

valid
boolean

Validation result.

Possible values:

  • true — the configuration is valid, and the form can be saved
  • false — there are violations

violations
array

Violations. Each element contains:

  • field — path to the value, for example crm.entityScheme or fields[0].type
  • message — description of the violation in English

Possible messages are listed on the crm.form.add page

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": "At least one of the required fields must be not empty: id, fields."
                    }
                ]
            }
        }
        

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

Request Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

HTTP status: 400

Field

Error description

How to Fix

-

At least one of the required fields must be not empty: id, fields

Pass id, fields, or both parameters

active

active is published for reading only

Do not pass active when validating a saved form

filter

crm.form.validate checks one form addressed by id and takes no filter.

Pass the identifier of a single form in id without filter

Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

HTTP status: 400

Field

Error description

How to Fix

fields

Unknown field sort found in entity FormDto

Pass only the fields listed in the CRM Form Structure section

Form Not Found Error

Error Code: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION

HTTP status: 404

Field

Error description

How to Fix

id

Entity with ID #ID# was not found

Check the identifier using the crm.form.list method

Plan Restrictions

Error Code: CRM_FORM_WRITE_RESTRICTED

HTTP status: 402

Field

Error description

How to Fix

-

You cannot modify CRM forms on your plan

Change the Bitrix24 plan

Access Errors

Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

HTTP status: 403

Field

Error description

How to Fix

-

Access denied

Make sure the user has permission to edit CRM forms

Error Code: CRM_FORM_SYSTEM_IMMUTABLE

HTTP status: 403

Field

Error description

How to Fix

id

Cannot edit or delete this CRM form

A system form cannot be modified

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