Create Process rpa.type.add

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: rpa

Who can execute the method: any user

DEPRECATED

The development of this method has been halted. Use Smart scripts as an alternative to this functionality.

This method creates a new process.

Method Parameters

Required parameters are marked with *

Name
type

Description

fields*
array

A list of process fields. The list of possible fields is described below

Parameter fields

Required parameters are marked with *

Name
type

Description

title*
string

The name of the process

image
string

The image of the process from the list

settings
array

A list of arbitrary settings for the process

permissions
array

A list of objects. Each object describes access permissions for this process

Warning

  • Automated scenarios, such as creating stages, Automation rules, and default fields, will not be triggered when creating a process via rest.
  • The request must specify access permissions for modifying the process.

Code Examples

Create a new process named "My Process." All users can create items for this process. Only the user with id = 1 can modify the settings of this process.

How to Use Examples in Documentation

{
            "fields": {
                "title": "My Process",
                "image": "list",
                "permissions": [
                    {
                        "accessCode": "UA",
                        "permission": "X",
                        "action": "ITEMS_CREATE"
                    },
                    {
                        "accessCode": "U1",
                        "permission": "X",
                        "action": "MODIFY"
                    },
                ]
            }
        }
        

Response Handling

The method will return data in the response similar to the response of the method rpa.type.get.

Continue Learning