Create a new custom type crm.type.add

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: any user with administrative access to the CRM section

This method creates a new SPA.

Method Parameters

Required parameters are marked with *

Name `type`	Description
fields* `object`	Field values (detailed description provided below) for adding a new SPA

Parameter fields

Required parameters are marked with *

Name `type`	Description	Default
title* `string`	Title of the SPA
entityTypeId `integer`	Identifier of the created SPA. If this field is not provided, it will be generated automatically. It should be noted that: This parameter is unique. It is not possible to create two SPAs with the same `entityTypeId` The value of `entityTypeId` must be within one of two ranges: an even integer that is greater than or equal to 1030 in the range from 128 to 192
relations `object`	An object containing links to other CRM entities. The structure is described below
isUseInUserfieldEnabled `boolean`	Is the use of the SPA in the user field enabled	`N`
linkedUserFields `object`	A set of user fields in which this SPA should be displayed. The structure is described below	`{}`
isAutomationEnabled `boolean`	Are Automation rules and triggers enabled	`N`
isBeginCloseDatesEnabled `boolean`	Are the Start Date and End Date fields enabled	`N`
isBizProcEnabled `boolean`	Is the business process designer enabled	`N`
isCategoriesEnabled `boolean`	Are custom sales funnels and tunnels enabled	`N`
isClientEnabled `boolean`	Is the Client field enabled. When this option is enabled, the SPA has a preset binding to Contacts and Companies	`N`
isDocumentsEnabled `boolean`	Is document printing enabled	`N`
isLinkWithProductsEnabled `boolean`	Is the binding of catalog products enabled	`N`
isMycompanyEnabled `boolean`	Is the Your Company Details field enabled	`N`
isObserversEnabled `boolean`	Is the Observers field enabled	`N`
isRecyclebinEnabled `boolean`	Is the use of the recycle bin enabled	`N`
isSetOpenPermissions `boolean`	Should new funnels be available to everyone	`Y`
isSourceEnabled `boolean`	Are the Source and Additional Information about Source fields enabled	`N`
isStagesEnabled `boolean`	Is the use of custom stages and kanban enabled	`N`
isExternal `boolean`	Is the SPA external to the CRM (linked to a digital workplace) This parameter is deprecated. For working with digital workplaces, use the methods `crm.automatedsolution.*`	`-`
customSectionId `integer`	Identifier of the digital workplace This parameter is deprecated. For working with digital workplaces, use the methods `crm.automatedsolution.*`	`-`
customSections `array`	Array of digital workplaces This parameter is deprecated. For working with digital workplaces, use the methods `crm.automatedsolution.*`	`-`

Relations relations

Name `type`	Description
parent `relation[]`	CRM elements that will be linked to this SPA
child `relation[]`	CRM elements to which this SPA will be linked

One relation relation

Required parameters are marked with *

Name
type

Description

Default

entityTypeId*
integer

Identifier of the system or custom type of the CRM object

-

isChildrenListEnabled
boolean

Should the linked element be added to the card.

Values Y and N do not work. You must pass "true" or "false"

"false"

Binding to user fields

linkedUserFields — a set of fields in which this SPA should be displayed.
This setting will only be considered if isUseInUserfieldEnabled = 'Y' is passed.

Name `type`	Description	Default Value
CALENDAR_EVENT\|UF_CRM_CAL_EVENT `boolean`	Calendar event	`"false"`
TASKS_TASK\|UF_CRM_TASK `boolean`	Tasks	`"false"`
TASKS_TASK_TEMPLATE\|UF_CRM_TASK `boolean`	Task templates	`"false"`

These parameters do not support passing values Y and N. Use "true" or "false".

Code Examples

How to Use Examples in Documentation

Let's create an SPA with the following conditions:

The most complete set of enabled settings
Link Leads, Deals, Invoices to the created SPA. Each link is added to the card of the elements of this SPA
Link the created SPA to Contacts and Companies. The link to Contacts is added to the card
The SPA should be displayed in the following fields: Calendar Event, Tasks

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"title":"SPA","entityTypeId":2024,"isAutomationEnabled":"Y","isBeginCloseDatesEnabled":"Y","isBizProcEnabled":"Y","isCategoriesEnabled":"Y","isClientEnabled":"Y","isDocumentsEnabled":"Y","isLinkWithProductsEnabled":"Y","isMycompanyEnabled":"Y","isObserversEnabled":"Y","isRecyclebinEnabled":"Y","isSetOpenPermissions":"Y","isSourceEnabled":"Y","isStagesEnabled":"Y","isUseInUserfieldEnabled":"Y","linkedUserFields":{"CALENDAR_EVENT|UF_CRM_CAL_EVENT":"true","TASKS_TASK|UF_CRM_TASK":"true"},"relations":{"parent":[{"entityTypeId":1,"isChildrenListEnabled":"true"},{"entityTypeId":2,"isChildrenListEnabled":"true"},{"entityTypeId":31,"isChildrenListEnabled":"true"}],"child":[{"entityTypeId":3,"isChildrenListEnabled":"true"},{"entityTypeId":4}]}}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.type.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"title":"SPA","entityTypeId":2024,"isAutomationEnabled":"Y","isBeginCloseDatesEnabled":"Y","isBizProcEnabled":"Y","isCategoriesEnabled":"Y","isClientEnabled":"Y","isDocumentsEnabled":"Y","isLinkWithProductsEnabled":"Y","isMycompanyEnabled":"Y","isObserversEnabled":"Y","isRecyclebinEnabled":"Y","isSetOpenPermissions":"Y","isSourceEnabled":"Y","isStagesEnabled":"Y","isUseInUserfieldEnabled":"Y","linkedUserFields":{"CALENDAR_EVENT|UF_CRM_CAL_EVENT":"true","TASKS_TASK|UF_CRM_TASK":"true"},"relations":{"parent":[{"entityTypeId":1,"isChildrenListEnabled":"true"},{"entityTypeId":2,"isChildrenListEnabled":"true"},{"entityTypeId":31,"isChildrenListEnabled":"true"}],"child":[{"entityTypeId":3,"isChildrenListEnabled":"true"},{"entityTypeId":4}]}},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.type.add

// 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, ISODate } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type TypeResult = {
          type: {
            id: number,
            createdBy: number,
            entityTypeId: number,
            isCategoriesEnabled: string,
            isStagesEnabled: string,
            isBeginCloseDatesEnabled: string,
            isClientEnabled: string,
            isUseInUserfieldEnabled: string,
            isLinkWithProductsEnabled: string,
            isMycompanyEnabled: string,
            isDocumentsEnabled: string,
            isSourceEnabled: string,
            isObserversEnabled: string,
            isRecyclebinEnabled: string,
            isAutomationEnabled: string,
            isBizProcEnabled: string,
            isSetOpenPermissions: string,
            isPaymentsEnabled: string,
            isCountersEnabled: string,
            createdTime: ISODate,
            updatedTime: ISODate,
            updatedBy: number,
            title: string,
            relations: {
              parent: Array<{ entityTypeId: number, isChildrenListEnabled: string, isPredefined: string }>,
              child: Array<{ entityTypeId: number, isChildrenListEnabled: string, isPredefined: string }>,
            },
            linkedUserFields: Record<string, string>,
            customSections: unknown[],
            customSectionId: number | null,
          },
        }
        
        try {
          const response = await $b24.actions.v2.call.make<TypeResult>({
            method: 'crm.type.add',
            params: {
              fields: {
                title: "Smart Process",
                entityTypeId: 2024,
                isAutomationEnabled: "Y",
                isBeginCloseDatesEnabled: "Y",
                isBizProcEnabled: "Y",
                isCategoriesEnabled: "Y",
                isClientEnabled: "Y",
                isDocumentsEnabled: "Y",
                isLinkWithProductsEnabled: "Y",
                isMycompanyEnabled: "Y",
                isObserversEnabled: "Y",
                isRecyclebinEnabled: "Y",
                isSetOpenPermissions: "Y",
                isSourceEnabled: "Y",
                isStagesEnabled: "Y",
                isUseInUserfieldEnabled: "Y",
                linkedUserFields: {
                  "CALENDAR_EVENT|UF_CRM_CAL_EVENT": "true",
                  "TASKS_TASK|UF_CRM_TASK": "true",
                },
                relations: {
                  parent: [
                    {
                      entityTypeId: 1,
                      isChildrenListEnabled: "true",
                    },
                    {
                      entityTypeId: 2,
                      isChildrenListEnabled: "true",
                    },
                    {
                      entityTypeId: 31,
                      isChildrenListEnabled: "true",
                    },
                  ],
                  child: [
                    {
                      entityTypeId: 3,
                      isChildrenListEnabled: "true",
                    },
                    {
                      entityTypeId: 4,
                    },
                  ],
                },
              },
            },
            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('Created smart process id:', result.type.id, 'entityTypeId:', result.type.entityTypeId)
          }
        } 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 addCrmType() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.type.add',
                params: {
                  fields: {
                    title: "Smart Process",
                    entityTypeId: 2024,
                    isAutomationEnabled: "Y",
                    isBeginCloseDatesEnabled: "Y",
                    isBizProcEnabled: "Y",
                    isCategoriesEnabled: "Y",
                    isClientEnabled: "Y",
                    isDocumentsEnabled: "Y",
                    isLinkWithProductsEnabled: "Y",
                    isMycompanyEnabled: "Y",
                    isObserversEnabled: "Y",
                    isRecyclebinEnabled: "Y",
                    isSetOpenPermissions: "Y",
                    isSourceEnabled: "Y",
                    isStagesEnabled: "Y",
                    isUseInUserfieldEnabled: "Y",
                    linkedUserFields: {
                      "CALENDAR_EVENT|UF_CRM_CAL_EVENT": "true",
                      "TASKS_TASK|UF_CRM_TASK": "true",
                    },
                    relations: {
                      parent: [
                        {
                          entityTypeId: 1,
                          isChildrenListEnabled: "true",
                        },
                        {
                          entityTypeId: 2,
                          isChildrenListEnabled: "true",
                        },
                        {
                          entityTypeId: 31,
                          isChildrenListEnabled: "true",
                        },
                      ],
                      child: [
                        {
                          entityTypeId: 3,
                          isChildrenListEnabled: "true",
                        },
                        {
                          entityTypeId: 4,
                        },
                      ],
                    },
                  },
                },
                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('Created smart process id:', result.type.id, 'entityTypeId:', result.type.entityTypeId)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addCrmType)
        </script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        try:
            bitrix_response = client.crm.type.add(fields={
                "title": "Documents",
                "code": "documents",
                "isCategoriesEnabled": "Y",
                "isStagesEnabled": "Y",
                "isClientEnabled": "Y",
                "isLinkWithProductsEnabled": "Y",
                "isMycompanyEnabled": "Y",
                "isDocumentsEnabled": "Y",
                "isAutomationEnabled": "Y",
                "isBizProcEnabled": "Y",
                "entityTypeId": 2024,
                "isBeginCloseDatesEnabled": "Y",
                "isObserversEnabled": "Y",
                "isRecyclebinEnabled": "Y",
                "isSetOpenPermissions": "Y",
                "isSourceEnabled": "Y",
                "isUseInUserfieldEnabled": "Y",
                "linkedUserFields": {
                    "CALENDAR_EVENT|UF_CRM_CAL_EVENT": "true",
                    "TASKS_TASK|UF_CRM_TASK": "true",
                },
                "relations": {
                    "parent": [
                        {
                            "entityTypeId": 1,
                            "isChildrenListEnabled": "true",
                        },
                        {
                            "entityTypeId": 2,
                            "isChildrenListEnabled": "true",
                        },
                        {
                            "entityTypeId": 31,
                            "isChildrenListEnabled": "true",
                        },
                    ],
                    "child": [
                        {
                            "entityTypeId": 3,
                            "isChildrenListEnabled": "true",
                        },
                        {
                            "entityTypeId": 4,
                        },
                    ],
                },
            }).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.type.add',
                    [
                        'fields' => [
                            'title'                     => "SPA",
                            'entityTypeId'              => 2024,
                            'isAutomationEnabled'       => "Y",
                            'isBeginCloseDatesEnabled'  => "Y",
                            'isBizProcEnabled'          => "Y",
                            'isCategoriesEnabled'       => "Y",
                            'isClientEnabled'           => "Y",
                            'isDocumentsEnabled'        => "Y",
                            'isLinkWithProductsEnabled' => "Y",
                            'isMycompanyEnabled'        => "Y",
                            'isObserversEnabled'        => "Y",
                            'isRecyclebinEnabled'       => "Y",
                            'isSetOpenPermissions'      => "Y",
                            'isSourceEnabled'           => "Y",
                            'isStagesEnabled'           => "Y",
                            'isUseInUserfieldEnabled'   => "Y",
                            'linkedUserFields'          => [
                                "CALENDAR_EVENT|UF_CRM_CAL_EVENT" => "true",
                                "TASKS_TASK|UF_CRM_TASK"          => "true",
                            ],
                            'relations'                 => [
                                'parent' => [
                                    [
                                        'entityTypeId'           => 1,
                                        'isChildrenListEnabled'  => "true",
                                    ],
                                    [
                                        'entityTypeId'           => 2,
                                        'isChildrenListEnabled'  => "true",
                                    ],
                                    [
                                        'entityTypeId'           => 31,
                                        'isChildrenListEnabled'  => "true",
                                    ],
                                ],
                                'child'  => [
                                    [
                                        'entityTypeId'           => 3,
                                        'isChildrenListEnabled'  => "true",
                                    ],
                                    [
                                        'entityTypeId'           => 4,
                                    ],
                                ],
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding CRM type: ' . $e->getMessage();
        }

BX24.callMethod(
            'crm.type.add',
            {
                fields: {
                    title: "SPA",
                    entityTypeId: 2024,
                    isAutomationEnabled: "Y",
                    isBeginCloseDatesEnabled: "Y",
                    isBizProcEnabled: "Y",
                    isCategoriesEnabled: "Y",
                    isClientEnabled: "Y",
                    isDocumentsEnabled: "Y",
                    isLinkWithProductsEnabled: "Y",
                    isMycompanyEnabled: "Y",
                    isObserversEnabled: "Y",
                    isRecyclebinEnabled: "Y",
                    isSetOpenPermissions: "Y",
                    isSourceEnabled: "Y",
                    isStagesEnabled: "Y",
                    isUseInUserfieldEnabled: "Y",
                    linkedUserFields: {
                        "CALENDAR_EVENT|UF_CRM_CAL_EVENT": "true",
                        "TASKS_TASK|UF_CRM_TASK": "true",
                    },
                    relations: {
                        parent: [
                            {
                                entityTypeId: 1,
                                isChildrenListEnabled: "true",
                            },
                            {
                                entityTypeId: 2,
                                isChildrenListEnabled: "true",
                            },
                            {
                                entityTypeId: 31,
                                isChildrenListEnabled: "true",
                                
                            },
                        ],
                        child: [
                            {
                                entityTypeId: 3,
                                isChildrenListEnabled: "true",
                            },
                            {
                                entityTypeId: 4,
                            },
                        ],
                    },
                },
            },
            (result) => {
                if (result.error())
                {
                    console.error(result.error());
        
                    return;
                }
        
                console.info(result.data());
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.type.add',
            [
                'fields' => [
                    'title' => "SPA",
                    'entityTypeId' => 2024,
                    'isAutomationEnabled' => "Y",
                    'isBeginCloseDatesEnabled' => "Y",
                    'isBizProcEnabled' => "Y",
                    'isCategoriesEnabled' => "Y",
                    'isClientEnabled' => "Y",
                    'isDocumentsEnabled' => "Y",
                    'isLinkWithProductsEnabled' => "Y",
                    'isMycompanyEnabled' => "Y",
                    'isObserversEnabled' => "Y",
                    'isRecyclebinEnabled' => "Y",
                    'isSetOpenPermissions' => "Y",
                    'isSourceEnabled' => "Y",
                    'isStagesEnabled' => "Y",
                    'isUseInUserfieldEnabled' => "Y",
                    'linkedUserFields' => [
                        "CALENDAR_EVENT|UF_CRM_CAL_EVENT" => "true",
                        "TASKS_TASK|UF_CRM_TASK" => "true",
                    ],
                    'relations' => [
                        'parent' => [
                            [
                                'entityTypeId' => 1,
                                'isChildrenListEnabled' => "true",
                            ],
                            [
                                'entityTypeId' => 2,
                                'isChildrenListEnabled' => "true",
                            ],
                            [
                                'entityTypeId' => 31,
                                'isChildrenListEnabled' => "true",
                            ],
                        ],
                        'child' => [
                            [
                                'entityTypeId' => 3,
                                'isChildrenListEnabled' => "true",
                            ],
                            [
                                'entityTypeId' => 4,
                            ],
                        ],
                    ],
                ],
            ]
        );
        
        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.type.add", b24.Params{
        	"fields": b24.Params{
        		"title":                     "SPA",
        		"entityTypeId":              2024,
        		"isAutomationEnabled":       "Y",
        		"isBeginCloseDatesEnabled":  "Y",
        		"isBizProcEnabled":          "Y",
        		"isCategoriesEnabled":       "Y",
        		"isClientEnabled":           "Y",
        		"isDocumentsEnabled":        "Y",
        		"isLinkWithProductsEnabled": "Y",
        		"isMycompanyEnabled":        "Y",
        		"isObserversEnabled":        "Y",
        		"isRecyclebinEnabled":       "Y",
        		"isSetOpenPermissions":      "Y",
        		"isSourceEnabled":           "Y",
        		"isStagesEnabled":           "Y",
        		"isUseInUserfieldEnabled":   "Y",
        		"linkedUserFields": b24.Params{
        			"CALENDAR_EVENT|UF_CRM_CAL_EVENT": "true",
        			"TASKS_TASK|UF_CRM_TASK":          "true",
        		},
        		"relations": b24.Params{
        			"parent": []b24.Params{
        				{
        					"entityTypeId":          1,
        					"isChildrenListEnabled": "true",
        				},
        				{
        					"entityTypeId":          2,
        					"isChildrenListEnabled": "true",
        				},
        				{
        					"entityTypeId":          31,
        					"isChildrenListEnabled": "true",
        				},
        			},
        			"child": []b24.Params{
        				{
        					"entityTypeId":          3,
        					"isChildrenListEnabled": "true",
        				},
        				{
        					"entityTypeId": 4,
        				},
        			},
        		},
        	},
        })
        if err != nil {
        	return fmt.Errorf("crm.type.add: %w", err)
        }
        
        // The method wraps the response in an object with the "type" key.
        raw, ok := b24.Unwrap(res.Result, "type")
        if !ok {
        	return fmt.Errorf("no type key in the response")
        }
        
        var item struct {
        	ID                       b24.ID `json:"id"`
        	CreatedBy                int    `json:"createdBy"`
        	EntityTypeID             b24.ID `json:"entityTypeId"`
        	IsCategoriesEnabled      string `json:"isCategoriesEnabled"`
        	IsStagesEnabled          string `json:"isStagesEnabled"`
        	IsBeginCloseDatesEnabled string `json:"isBeginCloseDatesEnabled"`
        }
        if err := json.Unmarshal(raw, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.ID, item.CreatedBy)

Response Handling

HTTP status: 200

{
            "result": {
                "type": {
                    "id": 16,
                    "createdBy": 1,
                    "entityTypeId": 2024,
                    "isCategoriesEnabled": "Y",
                    "isStagesEnabled": "Y",
                    "isBeginCloseDatesEnabled": "Y",
                    "isClientEnabled": "Y",
                    "isUseInUserfieldEnabled": "Y",
                    "isLinkWithProductsEnabled": "Y",
                    "isMycompanyEnabled": "Y",
                    "isDocumentsEnabled": "Y",
                    "isSourceEnabled": "Y",
                    "isObserversEnabled": "Y",
                    "isRecyclebinEnabled": "Y",
                    "isAutomationEnabled": "Y",
                    "isBizProcEnabled": "Y",
                    "isSetOpenPermissions": "Y",
                    "isPaymentsEnabled": "N",
                    "isCountersEnabled": "N",
                    "createdTime": "2024-07-05T19:47:33+02:00",
                    "updatedTime": "2024-07-05T19:47:33+02:00",
                    "updatedBy": 1,
                    "title": "SPA",
                    "relations": {
                        "parent": [
                            {
                                "entityTypeId": 3,
                                "isChildrenListEnabled": "Y",
                                "isPredefined": "Y"
                            },
                            {
                                "entityTypeId": 4,
                                "isChildrenListEnabled": "Y",
                                "isPredefined": "Y"
                            },
                            {
                                "entityTypeId": 1,
                                "isChildrenListEnabled": "Y",
                                "isPredefined": "N"
                            },
                            {
                                "entityTypeId": 2,
                                "isChildrenListEnabled": "Y",
                                "isPredefined": "N"
                            },
                            {
                                "entityTypeId": 31,
                                "isChildrenListEnabled": "Y",
                                "isPredefined": "N"
                            }
                        ],
                        "child": [
                            {
                                "entityTypeId": 3,
                                "isChildrenListEnabled": "Y",
                                "isPredefined": "N"
                            },
                            {
                                "entityTypeId": 4,
                                "isChildrenListEnabled": "N",
                                "isPredefined": "N"
                            }
                        ]
                    },
                    "linkedUserFields": {
                        "CALENDAR_EVENT|UF_CRM_CAL_EVENT": "Y",
                        "TASKS_TASK|UF_CRM_TASK": "Y",
                        "TASKS_TASK_TEMPLATE|UF_CRM_TASK": "N"
                    },
                    "customSections": [],
                    "customSectionId": null
                }
            },
            "time": {
                "start": 1720201651.707909,
                "finish": 1720201654.748627,
                "duration": 3.040717840194702,
                "processing": 2.71589994430542,
                "date_start": "2024-07-05T19:47:31+02:00",
                "date_finish": "2024-07-05T19:47:34+02:00",
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Root element of the response. Contains a single key `type`
type `type`	Information about the created SPA
time `time`	Information about the execution time of the request

Error Handling

HTTP status: 400, 403

{
            "error": "INVALID_ARG_VALUE", 
            "error_description": "entityTypeId is out of allowed range"
        }

Name `type`	Description
error `string`	String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only `error_description` shows the reason
error_description `string`	Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Status	Code	Description	Value
`400`	`INVALID_ARG_VALUE`	entityTypeId is out of allowed range	Occurs when an invalid `entityTypeId` is passed
`400`	`ACCESS_DENIED`	Access denied	Occurs if the user does not have administrative rights in CRM
`403`	`allowed_only_intranet_user`	Action allowed only for intranet users	Occurs if the user is not an intranet user
`400`	`100`	Could not find value for parameter	Occurs if the required parameter `fields` is not passed
`400`	`0`	Select a workplace where the SPA will be located	Occurs when `isExternal = 'true'`, but `customSectionId` is empty
`400`	`CREATE_DYNAMIC_TYPE_RESTRICTED`	Maximum number of SPAs exceeded	Creating an SPA is restricted due to the plan

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

Was the article helpful?

Overview of methods

Update custom type

Create a new custom type crm.type.add

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Relations relationsRelations relations

One relation relationOne relation relation

Binding to user fieldsBinding to user fields

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Was the article helpful?

Method Parameters

Parameter fields

Relations relations

One relation relation

Binding to user fields

Code Examples

Response Handling

Returned Data

Error Handling

Possible Error Codes

Statuses and System Error Codes

Continue Learning