Update User Type crm.type.update

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 updates an existing SPA by its identifier id.

Method Parameters

Required parameters are marked with *

Name `type`	Description
id* `integer`	Identifier of the SPA. Can be obtained using the methods: `crm.type.list`, `crm.type.add`
fields `object`	Field values (detailed description provided below) for updating the SPA

Parameter fields

Name `type`	Description
title `string`	Title of the SPA
relations `object`	An object containing links to other CRM entities. The structure is described by the object `type.relations`
isUseInUserfieldEnabled `boolean`	Is the use of the SPA in the user field enabled
linkedUserFields `object`	A set of user fields in which this SPA should be displayed. The structure is described by the object `type.linkedUserFields`
isAutomationEnabled `boolean`	Are automation rules and triggers enabled
isBeginCloseDatesEnabled `boolean`	Are the Start Date and End Date fields enabled
isBizProcEnabled `boolean`	Is the use of the business process designer enabled
isCategoriesEnabled `boolean`	Are custom Sales Funnels and sales tunnels enabled
isClientEnabled `boolean`	Is the Client field enabled. When this option is enabled, the SPA has a preset link to Contacts and Companies
isDocumentsEnabled `boolean`	Is document printing enabled
isLinkWithProductsEnabled `boolean`	Is the link to catalog products enabled
isMycompanyEnabled `boolean`	Is the Your Company Details field enabled
isObserversEnabled `boolean`	Is the Observers field enabled
isRecyclebinEnabled `boolean`	Is the use of the recycle bin enabled
isSetOpenPermissions `boolean`	Should new funnels be made available to everyone
isSourceEnabled `boolean`	Are the Source and Additional Information about Source fields enabled
isStagesEnabled `boolean`	Is the use of custom stages and Kanban enabled
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.*`

Note

Changes to the SPA settings fields occur only when the modifiable field values are passed.

For example, if you need to disable document printing functionality for the SPA with id = 128, you would pass the following parameters:

{
            "id": 128,
            "fields": {
                "isDocumentsEnabled": "N"
            }
        }

Relations

Settings must be passed in full; they are completely overwritten.
You cannot change the settings of predefined links (iPredefined: true). These settings can be omitted in the request.
If an error occurs while trying to save the passed link settings, it will not be displayed. The settings will simply not be saved.

Code Examples

For the SPA with id = 20:

Disable the following settings:
- Automation rules and triggers
- Start Date and End Date fields
- Client field
- Observers field
Enable the following settings:
- Source and Additional Information about Source fields
- Use of custom stages and Kanban
Enable display of the SPA in the Tasks field

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":20,"fields":{"isAutomationEnabled":"N","isBeginCloseDatesEnabled":"N","isClientEnabled":"N","isObserversEnabled":"N","isSourceEnabled":"Y","isStagesEnabled":"Y","isUseInUserfieldEnabled":"Y","linkedUserFields":{"TASKS_TASK|UF_CRM_TASK":"true"}}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.type.update

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":20,"fields":{"isAutomationEnabled":"N","isBeginCloseDatesEnabled":"N","isClientEnabled":"N","isObserversEnabled":"N","isSourceEnabled":"Y","isStagesEnabled":"Y","isUseInUserfieldEnabled":"Y","linkedUserFields":{"TASKS_TASK|UF_CRM_TASK":"true"}},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.type.update

// 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
        
        type SmartProcessType = {
          id: number
          title: string
          entityTypeId: number
        }
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type TypeUpdateResult = {
          type: SmartProcessType
        }
        
        try {
          const response = await $b24.actions.v2.call.make<TypeUpdateResult>({
            method: 'crm.type.update',
            params: {
              id: 20,
              fields: {
                isAutomationEnabled: 'N',
                isBeginCloseDatesEnabled: 'N',
                isClientEnabled: 'N',
                isObserversEnabled: 'N',
                isSourceEnabled: 'Y',
                isStagesEnabled: 'Y',
                isUseInUserfieldEnabled: 'Y',
                linkedUserFields: {
                  'TASKS_TASK|UF_CRM_TASK': 'true',
                },
              },
            },
            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(`Updated smart process #${result.type.id} (${result.type.title})`)
          }
        } 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 updateSmartProcessSettings() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.type.update',
                params: {
                  id: 20,
                  fields: {
                    isAutomationEnabled: 'N',
                    isBeginCloseDatesEnabled: 'N',
                    isClientEnabled: 'N',
                    isObserversEnabled: 'N',
                    isSourceEnabled: 'Y',
                    isStagesEnabled: 'Y',
                    isUseInUserfieldEnabled: 'Y',
                    linkedUserFields: {
                      'TASKS_TASK|UF_CRM_TASK': 'true',
                    },
                  },
                },
                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(`Updated smart process #${result.type.id} (${result.type.title})`)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', updateSmartProcessSettings)
        </script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.type.update(
                bitrix_id=20,
                fields={
                    "relations": {
                        "parent": [],
                        "child": [
                            {
                                "entityTypeId": 1,
                                "isChildrenListEnabled": "true",
                            },
                            {
                                "entityTypeId": 2,
                                "isChildrenListEnabled": "false",
                            },
                        ],
                    },
                },
            ).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}")

require_once('crest.php');
        
        $result = CRest::call(
            'crm.type.update',
            [
                'id' => 20,
                'fields' => [
                    'isAutomationEnabled' => "N",
                    'isBeginCloseDatesEnabled' => "N",
                    'isClientEnabled' => "N",
                    'isObserversEnabled' => "N",
                    'isSourceEnabled' => "Y",
                    'isStagesEnabled' => "Y",
                    'isUseInUserfieldEnabled' => "Y",
                    'linkedUserFields' => [
                        "TASKS_TASK|UF_CRM_TASK" => "true",
                    ],
                ]
            ]
        );
        
        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.update", b24.Params{
        	"id": 20,
        	"fields": b24.Params{
        		"isAutomationEnabled":      "N",
        		"isBeginCloseDatesEnabled": "N",
        		"isClientEnabled":          "N",
        		"isObserversEnabled":       "N",
        		"isSourceEnabled":          "Y",
        		"isStagesEnabled":          "Y",
        		"isUseInUserfieldEnabled":  "Y",
        		"linkedUserFields": b24.Params{
        			"TASKS_TASK|UF_CRM_TASK": "true",
        		},
        	},
        })
        if err != nil {
        	return fmt.Errorf("crm.type.update: %w", err)
        }
        
        // The response arrives as json.RawMessage — unmarshal it
        // into a struct matching the response shape shown below on this page.
        fmt.Printf("%s\n", res.Result)

Suppose for the SPA with id = 20 you need to:

Remove all entities linked to the SPA (relations.parent)
Enable "show in detail form" for Leads linked to the SPA

Initial relations in the SPA:

{
            "relations": {
                "parent": [
                    {
                        "entityTypeId": 31,
                        "isChildrenListEnabled": "N",
                        "isPredefined": "N"
                    }
                ],
                "child": [
                    {
                        "entityTypeId": 1,
                        "isChildrenListEnabled": "N",
                        "isPredefined": "N"
                    },
                    {
                        "entityTypeId": 2,
                        "isChildrenListEnabled": "N",
                        "isPredefined": "N"
                    }
                ]
            }
        }

Final request:

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":20,"fields":{"relations":{"parent":[],"child":[{"entityTypeId":1,"isChildrenListEnabled":"true"},{"entityTypeId":2,"isChildrenListEnabled":"false"}]}}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.type.update

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":20,"fields":{"relations":{"parent":[],"child":[{"entityTypeId":1,"isChildrenListEnabled":"true"},{"entityTypeId":2,"isChildrenListEnabled":"false"}]}},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.type.update

// 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
        
        type SmartProcessType = {
          id: number
          title: string
          entityTypeId: number
        }
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type TypeUpdateResult = {
          type: SmartProcessType
        }
        
        try {
          const response = await $b24.actions.v2.call.make<TypeUpdateResult>({
            method: 'crm.type.update',
            params: {
              id: 20,
              fields: {
                relations: {
                  parent: [],
                  child: [
                    {
                      entityTypeId: 1,
                      isChildrenListEnabled: 'true',
                    },
                    {
                      entityTypeId: 2,
                      isChildrenListEnabled: 'false',
                    },
                  ],
                },
              },
            },
            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(`Updated smart process #${result.type.id} (${result.type.title})`)
          }
        } 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 updateSmartProcessRelations() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.type.update',
                params: {
                  id: 20,
                  fields: {
                    relations: {
                      parent: [],
                      child: [
                        {
                          entityTypeId: 1,
                          isChildrenListEnabled: 'true',
                        },
                        {
                          entityTypeId: 2,
                          isChildrenListEnabled: 'false',
                        },
                      ],
                    },
                  },
                },
                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(`Updated smart process #${result.type.id} (${result.type.title})`)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', updateSmartProcessRelations)
        </script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.type.update(
                bitrix_id=20,
                fields={
                    "relations": {
                        "parent": [],
                        "child": [
                            {
                                "entityTypeId": 1,
                                "isChildrenListEnabled": "true",
                            },
                            {
                                "entityTypeId": 2,
                                "isChildrenListEnabled": "false",
                            },
                        ],
                    },
                },
            ).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}")

require_once('crest.php');
        
        $result = CRest::call(
            'crm.type.update',
            [
                'id' => 20,
                'fields' => [
                    'relations' => [
                        'parent' => [],
                        'child' => [
                            [
                                "entityTypeId" => 1,
                                "isChildrenListEnabled" => "true",
                            ],
                            [
                                "entityTypeId" => 2,
                                "isChildrenListEnabled" => "false",
                            ]
                        ],
                    ],
                ]
            ]
        );
        
        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.update", b24.Params{
        	"id": 20,
        	"fields": b24.Params{
        		"relations": b24.Params{
        			"parent": []any{},
        			"child": []b24.Params{
        				{
        					"entityTypeId":          1,
        					"isChildrenListEnabled": "true",
        				},
        				{
        					"entityTypeId":          2,
        					"isChildrenListEnabled": "false",
        				},
        			},
        		},
        	},
        })
        if err != nil {
        	return fmt.Errorf("crm.type.update: %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"`
        	Title               string `json:"title"`
        	Code                string `json:"code"`
        	CreatedBy           int    `json:"createdBy"`
        	EntityTypeID        b24.ID `json:"entityTypeId"`
        	IsCategoriesEnabled string `json:"isCategoriesEnabled"`
        }
        if err := json.Unmarshal(raw, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.ID, item.Title)

Response Handling

HTTP Status: 200

{
            "result": {
                "type": {
                    "id": 20,
                    "title": "SPA #3",
                    "code": "",
                    "createdBy": 1,
                    "entityTypeId": 1222,
                    "customSectionId": null,
                    "isCategoriesEnabled": "Y",
                    "isStagesEnabled": "Y",
                    "isBeginCloseDatesEnabled": "N",
                    "isClientEnabled": "N",
                    "isUseInUserfieldEnabled": "Y",
                    "isLinkWithProductsEnabled": "N",
                    "isMycompanyEnabled": "Y",
                    "isDocumentsEnabled": "N",
                    "isSourceEnabled": "Y",
                    "isObserversEnabled": "N",
                    "isRecyclebinEnabled": "N",
                    "isAutomationEnabled": "N",
                    "isBizProcEnabled": "N",
                    "isSetOpenPermissions": "Y",
                    "isPaymentsEnabled": "N",
                    "isCountersEnabled": "N",
                    "createdTime": "2024-07-08T17:24:47+02:00",
                    "updatedTime": "2024-07-09T20:55:37+02:00",
                    "updatedBy": 1,
                    "relations": {
                        "parent": [],
                        "child": [
                            {
                                "entityTypeId": 1,
                                "isChildrenListEnabled": "Y",
                                "isPredefined": "N"
                            },
                            {
                                "entityTypeId": 2,
                                "isChildrenListEnabled": "Y",
                                "isPredefined": "N"
                            }
                        ]
                    },
                    "linkedUserFields": {
                        "CALENDAR_EVENT|UF_CRM_CAL_EVENT": "N",
                        "TASKS_TASK|UF_CRM_TASK": "Y",
                        "TASKS_TASK_TEMPLATE|UF_CRM_TASK": "N"
                    },
                    "customSections": []
                }
            },
            "time": {
                "start": 1720551426.116454,
                "finish": 1720551426.816224,
                "duration": 0.6997702121734619,
                "processing": 0.20451998710632324,
                "date_start": "2024-07-09T20:57:06+02:00",
                "date_finish": "2024-07-09T20:57:06+02:00",
                "operating": 0.2044668197631836
            }
        }

Returned Data

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

Error Handling

HTTP Status: 400

{
            "error": 0,
            "error_description": "SPA not found"
        }

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`	`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`	`UPDATE_DYNAMIC_TYPE_RESTRICTED`	You cannot change the SPA settings due to your plan's restrictions	SPAs are not available on your plan
`400`	`0`	Select a workplace where the SPA will be located	When passing `isExternal = 'true'`, but with an empty `customSectionId`

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?

Create a new custom type

Get custom type by id

Update User Type crm.type.update

Method ParametersMethod Parameters

Parameter fieldsParameter fields

RelationsRelations

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