Update Digital Workplace crm.automatedsolution.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: users with administrative access to the crm section

This method updates the existing settings of the digital workplace with the identifier id. If any of the fields are not provided, their values will remain unchanged.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
integer

Identifier of the digital workplace. It can be obtained from the response of the method crm.automatedsolution.add (result.automatedSolution.id), which was called when adding the digital workplace, or crm.automatedsolution.list. You can also use the "Digital Workplaces" section in the Bitrix24 account — the ID column in the list of digital workplaces

fields*
object

Field values (detailed description provided below) for creating a digital workplace in the following structure:

"fields": {
            "title": "value",
            "typeIds": []
        }

Parameter fields

Name
type

Description

title
string

Title of the digital workplace.

Be careful when changing the title field. Since the link to the digital workplace is built based on the title, changing it will also change the link to the digital workplace

typeIds
crm_dynamic_type.id[]

Array of identifiers of SPAs that need to be linked to this workplace.

To change the list of linked SPAs, you need to pass the typeIds field with the desired set of SPAs.

Warning

Settings are completely overwritten. When changing the list of linked SPAs, you must pass the typeIds set in its entirety, or omit the typeIds key altogether

Code Examples

How to Use Examples in Documentation

  1. Change the title of the digital workplace

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

    Example

    
        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.automatedsolution.update(
                bitrix_id=238,
                fields={
                    "title": "HR and Customer Success",
                },
            ).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.update',
            [
                'id' => 238,
                'fields' =>
                [
                    'title' => 'HR & Customer Success'
                ]
            ]
        );
        
        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.update", b24.Params{
        	"id": 238,
        	"fields": b24.Params{
        		"title": "HR & Customer Success",
        	},
        })
        if err != nil {
        	return fmt.Errorf("crm.automatedsolution.update: %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)

  2. Change the list of linked SPAs

    Suppose the digital workplace with id = 267 had two SPAs linked — one with id = 14, and the other with id = 158. If we want the digital workplace to retain only one SPA, we pass the typeIds field containing only the desired SPAs:

    curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":238,"fields":{"typeIds":[14]}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.automatedsolution.update
        
    curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":238,"fields":{"typeIds":[14]},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.automatedsolution.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
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type AutomatedSolutionUpdateResult = {
          automatedSolution: {
            id: number
            title: string
            typeIds: number[]
          }
        }
        
        try {
          const response = await $b24.actions.v2.call.make<AutomatedSolutionUpdateResult>({
            method: 'crm.automatedsolution.update',
            params: {
              id: 238,
              fields: {
                typeIds: [14],
              },
            },
            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.id, result.automatedSolution.title, result.automatedSolution.typeIds)
          }
        } 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 updateAutomatedSolution() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.automatedsolution.update',
                params: {
                  id: 238,
                  fields: {
                    typeIds: [14],
                  },
                },
                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.id, result.automatedSolution.title, result.automatedSolution.typeIds)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', updateAutomatedSolution)
        </script>
        
    
        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.automatedsolution.update(
                bitrix_id=238,
                fields={
                    "typeIds": [
                        14,
                    ],
                },
            ).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.update',
            [
                'id' => 238,
                'fields' =>
                [
                    'typeIds' => [14]
                ]
            ]
        );
        
        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.update", b24.Params{
        	"id": 238,
        	"fields": b24.Params{
        		"typeIds": []int{14},
        	},
        })
        if err != nil {
        	return fmt.Errorf("crm.automatedsolution.update: %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)

  3. Unlink all SPAs

    To unlink all SPAs from the digital workplace, you need to pass an empty array as typeIds.

    curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":238,"fields":{"typeIds":[]}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.automatedsolution.update
        
    curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":238,"fields":{"typeIds":[]},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.automatedsolution.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
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type AutomatedSolutionUpdateResult = {
          automatedSolution: {
            id: number
            title: string
            typeIds: number[]
          }
        }
        
        try {
          const response = await $b24.actions.v2.call.make<AutomatedSolutionUpdateResult>({
            method: 'crm.automatedsolution.update',
            params: {
              id: 238,
              fields: {
                typeIds: [],
              },
            },
            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.id, result.automatedSolution.title, result.automatedSolution.typeIds)
          }
        } 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 updateAutomatedSolution() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.automatedsolution.update',
                params: {
                  id: 238,
                  fields: {
                    typeIds: [],
                  },
                },
                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.id, result.automatedSolution.title, result.automatedSolution.typeIds)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', updateAutomatedSolution)
        </script>
        
    
        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.automatedsolution.update(
                bitrix_id=238,
                fields={
                    "typeIds": [],
                },
            ).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.update',
            [
                'id' => 238,
                'fields' =>
                [
                    'typeIds' => []
                ]
            ]
        );
        
        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.update", b24.Params{
        	"id": 238,
        	"fields": b24.Params{
        		"typeIds": []any{},
        	},
        })
        if err != nil {
        	return fmt.Errorf("crm.automatedsolution.update: %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

Object containing information about the updated digital workplace

time
time

Information about the request execution time

Error Handling

HTTP status: 400

{
            "error":"BX_EMPTY_REQUIRED",
            "error_description":"Required field is not filled"
        }

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

BX_EMPTY_REQUIRED

Required field is not filled

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

Previous
Create a Digital Workspace
Next
Retrieve Digital Workspace Data by ID