Create Digital Workspace crm.automatedsolution.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: a Bitrix24 administrator or a user with the "Edit automation solutions" or "Edit settings" permission for "Automated solutions" in CRM access permissions

The method crm.automatedsolution.add creates a digital workspace.

In cloud Bitrix24, the maximum number of digital workspaces depends on the plan. In the on-premise version, the limit is set by the automated_solution_limit option of the crm module, 200 by default. The limit counts all workspaces, including those installed from the Automated solution gallery.

Method Parameters

Required parameters are marked with *

Name `type`	Description
fields* `object`	Field values (detailed description) for creating a digital workspace in the form of a structure: `"fields": { "title": "value", "typeIds": [] }`

Parameter fields

Required parameters are marked with *

Name
type

Description

title*
string

The name of the digital workspace. The link to the workspace section in Bitrix24 is built from the name

typeIds
crm_dynamic_type.id[]

An array of SPA type identifiers (id) to link to this workspace. If not passed, the workspace is created without SPAs. Non-existent identifiers are ignored without an error.

If an SPA is already linked to another workspace or to CRM, it is removed from its previous place when linked to the new workspace. To move an SPA from CRM, the "User can edit preferences" CRM permission is also required.

A digital workspace without SPAs is not displayed in the left menu, but it can be found in the list of digital workspaces

Code Examples

How to Use Examples in Documentation

Create a digital workspace and immediately link SPAs to it

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"title":"HR","typeIds":[1,2,3]}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.automatedsolution.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"title":"HR","typeIds":[1,2,3]},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.automatedsolution.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 } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type AutomatedSolutionAddResult = {
          automatedSolution: {
            id: number
            title: string
            typeIds: number[]
          }
        }
        
        try {
          const response = await $b24.actions.v2.call.make<AutomatedSolutionAddResult>({
            method: 'crm.automatedsolution.add',
            params: {
              fields: {
                title: 'HR',
                typeIds: [1, 2, 3],
              },
            },
            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.automatedSolution)
          }
        } 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 addAutomatedSolution() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.automatedsolution.add',
                params: {
                  fields: {
                    title: 'HR',
                    typeIds: [1, 2, 3],
                  },
                },
                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.automatedSolution)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addAutomatedSolution)
        </script>

Example


        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.automatedsolution.add(
                fields={
                    "title": "HR",
                    "typeIds": [1, 2, 3],
                },
            ).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.automatedsolution.add',
            [
                'fields' =>
                [
                    'title' => 'HR',
                    'typeIds' => [1, 2, 3]
                ]
            ]
        );
        
        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.automatedsolution.add", b24.Params{
        	"fields": b24.Params{
        		"title":   "HR",
        		"typeIds": []int{1, 2, 3},
        	},
        })
        if err != nil {
        	return fmt.Errorf("crm.automatedsolution.add: %w", err)
        }
        
        // The method wraps the response in an object with the "automatedSolution" key.
        raw, ok := b24.Unwrap(res.Result, "automatedSolution")
        if !ok {
        	return fmt.Errorf("no automatedSolution key in the response")
        }
        
        var item struct {
        	ID    b24.ID `json:"id"`
        	Title string `json:"title"`
        }
        if err := json.Unmarshal(raw, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.ID, item.Title)

Create a digital workspace without SPAs

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"title":"HR"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.automatedsolution.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"title":"HR"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.automatedsolution.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 } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type AutomatedSolutionAddResult = {
          automatedSolution: {
            id: number
            title: string
            typeIds: number[]
          }
        }
        
        try {
          const response = await $b24.actions.v2.call.make<AutomatedSolutionAddResult>({
            method: 'crm.automatedsolution.add',
            params: {
              fields: {
                title: 'HR',
              },
            },
            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.automatedSolution)
          }
        } 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 addAutomatedSolution() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.automatedsolution.add',
                params: {
                  fields: {
                    title: 'HR',
                  },
                },
                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.automatedSolution)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addAutomatedSolution)
        </script>


        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.automatedsolution.add(
                fields={
                    "title": "HR",
                },
            ).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.automatedsolution.add',
            [
                'fields' =>
                [
                    'title' => 'HR'
                ]
            ]
        );
        
        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.automatedsolution.add", b24.Params{
        	"fields": b24.Params{
        		"title": "HR",
        	},
        })
        if err != nil {
        	return fmt.Errorf("crm.automatedsolution.add: %w", err)
        }
        
        // The method wraps the response in an object with the "automatedSolution" key.
        raw, ok := b24.Unwrap(res.Result, "automatedSolution")
        if !ok {
        	return fmt.Errorf("no automatedSolution key in the response")
        }
        
        var item struct {
        	ID    b24.ID `json:"id"`
        	Title string `json:"title"`
        }
        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": {
                "automatedSolution": {
                    "id": 1,
                    "title": "HR",
                    "typeIds": [
                        1,
                        2,
                        3
                    ]
                }
            },
            "time": {
                "start": 1715849396.642359,
                "finish": 1715849396.954623,
                "duration": 0.31226396560668945,
                "processing": 0.0068209171295166016,
                "date_start": "2024-05-16T11:49:56+03:00",
                "date_finish": "2024-05-16T11:49:56+03:00",
                "operating_reset_at": 1715849996,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Root element of the response
automatedSolution `object`	The created digital workspace. The object is nested in `result` (detailed description)
time `time`	Information about the execution time of the request

Object automatedSolution

Name `type`	Description
id `integer`	Identifier of the created digital workspace. Pass it to the `id` parameter of the crm.automatedsolution.update, crm.automatedsolution.get, and crm.automatedsolution.delete methods
title `string`	Name of the digital workspace
typeIds `crm_dynamic_type.id[]`	Identifiers of the SPAs linked to the workspace. If `typeIds` was not passed on creation, an empty array is returned

Error Handling

HTTP status: 400

{
            "error": "BX_EMPTY_REQUIRED",
            "error_description":"The field Name is required."
        }

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

Code	Description
`ACCESS_DENIED`	Insufficient permissions
`LIMIT_EXCEEDED`	The number of available digital workspaces has been exceeded
`BX_EMPTY_REQUIRED`	A required field is not filled
`0`	SPAs cannot be moved from workspaces installed from the Automated solution gallery

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?

Methods Overview

Modify a Digital Workspace

Create Digital Workspace crm.automatedsolution.add

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Object automatedSolutionObject automatedSolution

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning