Create Digital Workspace crm.automatedsolution.add

Scope: crm

Who can execute the method: users with administrative access to the CRM section

This method will create a new digital workspace.

In the cloud, the maximum number of digital workspaces depends on the plan. In on-premise, the maximum number depends on technical limitations.

Method ParametersMethod Parameters

Required parameters are marked with *

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

Parameter fieldsParameter fields

Required parameters are marked with *

Code ExamplesCode Examples

How to Use Examples in Documentation

1. Create a digital workspace and immediately link SPAs to it

   cURL (Webhook)

   cURL (OAuth)

   JS

   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
           

   BX24.callMethod(
               'crm.automatedsolution.add',
               {
                   "fields": {
                       "title": "HR",
                       "typeIds": [
                           1,
                           2,
                           3
                       ]
                   }
               },
               function(result) {
                   if (result.error()) {
                       console.error(result.error());
                   } else {
                       console.info(result.data());
                   }
               }
           );
           

   require_once('crest.php');
           
           $result = CRest::call(
               'crm.automatedsolution.add',
               [
                   'fields' =>
                   [
                       'title' => 'HR',
                       'typeIds' => [1, 2, 3]
                   ]
               ]
           );
           
           echo '<PRE>';
           print_r($result);
           echo '</PRE>';
           

2. Create a digital workspace without SPAs

   cURL (Webhook)

   cURL (OAuth)

   JS

   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
           

   BX24.callMethod(
               'crm.automatedsolution.add',
               {
                   "fields": {
                       "title": "HR"
                   }
               },
               function(result) {
                   if (result.error()) {
                       console.error(result.error());
                   } else {
                       console.info(result.data());
                   }
               }
           );
           

   require_once('crest.php');
           
           $result = CRest::call(
               'crm.automatedsolution.add',
               [
                   'fields' =>
                   [
                       'title' => 'HR'
                   ]
               ]
           );
           
           echo '<PRE>';
           print_r($result);
           echo '</PRE>';
           

Response HandlingResponse 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 DataReturned Data

Error HandlingError Handling

HTTP status: 400

{
            "error": "BX_EMPTY_REQUIRED",
            "error_description":"The required field 'Title' is not filled"
        }
        

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Continue LearningContinue Learning

• Digital Workspaces
• Update Digital Workplace crm.automatedsolution.update
• Get data about the digital workplace by id crm.automatedsolution.get
• Get a list of digital workspaces crm.automatedsolution.list
• Delete Digital Workplace crm.automatedsolution.delete
• Get fields of the digital workplace crm.automatedsolution.fields