Run a business process
execute-processStart a Creatio business process by its schema name, pass optional parameter values, and return the process result. Use it to trigger automated workflows that may change data.
Instructions
Start a Creatio business process by its schema name, with optional parameters, and return its result. A process can change any data it is designed to — make sure the user wants it run. User/contact parameters take a contact id (get-guide: contactid-guide).
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"processName": "<processName>"
},
"name": "execute-process"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| parameters | No | Process parameters by their codes, e.g. { "ContactId": "<guid>", "Amount": 1000, "SendNotification": true }. Values are passed to the process as written. | |
| processName | Yes | Schema name of the process (e.g. "UsrLeadQualification"), not its caption. To find it from a caption, read VwProcessLib: select ["Name", "Caption"], filters { all: [{ field: "Caption", op: "contains", value: "<caption>" }] }, and use `Name`. |