Update Digital Workplace crm.automatedsolution.update

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

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 (Webhook)

cURL (OAuth)

PHP

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

BX24.callMethod(
            'crm.automatedsolution.update',
            {
                "id": 238,
                "fields": {
                    "typeIds": [
                        14
                    ]
                }
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.automatedsolution.update',
            [
                'id' => 238,
                'fields' =>
                [
                    'typeIds' => [14]
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Unlink all SPAs

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

cURL (Webhook)

cURL (OAuth)

PHP

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

BX24.callMethod(
            'crm.automatedsolution.update',
            {
                "id": 238,
                "fields": {
                    "typeIds": []
                }
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.automatedsolution.update',
            [
                'id' => 238,
                'fields' =>
                [
                    'typeIds' => []
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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 may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code	Description
`ACCESS_DENIED`	Insufficient permissions
`BX_EMPTY_REQUIRED`	Required field is not filled

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Create a Digital Workspace

Retrieve Digital Workspace Data by ID

Update Digital Workplace crm.automatedsolution.update

Method ParametersMethod Parameters

Parameter fieldsParameter 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