Update workflow transition rule configurations

PUT

/rest/api/3/workflow/rule/config

Updates configuration of workflow transition rules. The following rule types are supported:

post functions

conditions

validators

Only rules created by the calling Connect or Forge app can be updated.

To assist with app migration, this operation can be used to:

Disable a rule.

Add a tag. Use this to filter rules in the Get workflow transition rule configurations.

Rules are enabled if the disabled parameter is not provided.

Permissions required: Only Connect or Forge apps can use this operation.

Request

Body Params application/json

Examples

Responses

🟢200OK

application/json

Returned if the request is successful.

Body

🟠400Bad Request

🟠403Forbidden

🔴503Service Unavailable

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT '/rest/api/3/workflow/rule/config' \
--header 'Content-Type: application/json' \
--data-raw '{
    "workflows": [
        {
            "conditions": [
                {
                    "configuration": {
                        "disabled": false,
                        "tag": "Another tag",
                        "value": "{ \"size\": \"medium\" }"
                    },
                    "id": "d663bd873d93-59f5-11e9-8647-b4d6cbdc"
                }
            ],
            "postFunctions": [
                {
                    "configuration": {
                        "disabled": false,
                        "tag": "Sample tag",
                        "value": "{ \"color\": \"red\" }"
                    },
                    "id": "b4d6cbdc-59f5-11e9-8647-d663bd873d93"
                }
            ],
            "validators": [
                {
                    "configuration": {
                        "disabled": false,
                        "value": "{ \"shape\": \"square\" }"
                    },
                    "id": "11e9-59f5-b4d6cbdc-8647-d663bd873d93"
                }
            ],
            "workflowId": {
                "draft": false,
                "name": "My Workflow name"
            }
        }
    ]
}'

Response Example

200 - Success

{"updateResults":[{"workflowId":{"name":"Workflow with one rule not updated","draft":false},"ruleUpdateErrors":{"example-rule-id":["The rule with this id does not exist: example-rule-id"]},"updateErrors":[]},{"workflowId":{"name":"Workflow with all rules successfully updated","draft":true},"ruleUpdateErrors":{},"updateErrors":[]},{"workflowId":{"name":"Non-existing workflow","draft":false},"ruleUpdateErrors":{},"updateErrors":["Workflow not found: WorkflowIdBean{name=Non-existing workflow, draft=false}"]}]}

Modified at 2025-07-16 07:18:01

Get workflow transition rule configurations

Delete workflow transition rule configurations