Atlassian: Update workflow transition rule configurations

← Workflow transition rules operations · Get started

Operation atlassian.updateworkflowtransitionruleconfigurations

Provider route: PUT /{cloudId}/rest/api/3/workflow/rule/config. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/atlassian with npm, or alter-sdk-atlassian with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { AtlassianIntegration } from "@alter-ai/atlassian";

async function execute(input: Parameters<AtlassianIntegration["workflowTransitionRules"]["updateWorkflowTransitionRuleConfigurations"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new AtlassianIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.workflowTransitionRules.updateWorkflowTransitionRuleConfigurations(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_atlassian import AtlassianIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = AtlassianIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.workflow_transition_rules.update_workflow_transition_rule_configurations(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.cloudId	string	Required within parent	Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
body	Model	Required within parent	Expand Update workflow transition rule configurations — request body — body

Referenced models: Update workflow transition rule configurations — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Update workflow transition rule configurations — response body

Referenced models: Update workflow transition rule configurations — response body

Schemas

Update workflow transition rule configurations — response body

Field	Type	Presence	Description and constraints
$	object	Root	Details of any errors encountered while updating workflow transition rules.
updateResults	JSON	Optional
updateResults (anyOf 1)	array	Alternative	A list of workflows.
updateResults (anyOf 1)[]	Model	Each item	Expand Update workflow transition rule configurations — response body — update Results A list of workflows item
updateResults (anyOf 2)	null	Alternative

Referenced models: Update workflow transition rule configurations — response body — update Results A list of workflows item

Update workflow transition rule configurations — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Details about a workflow configuration update request. Additional keys: not allowed
workflows	array	Required within parent	The list of workflows with transition rules to update.
workflows[]	Model	Each item	Expand Update workflow transition rule configurations — request body — body workflows item

Referenced models: Update workflow transition rule configurations — request body — body workflows item

Update workflow transition rule configurations — response body — update Results A list of workflows item

Field	Type	Presence	Description and constraints
$	object	Root	Details of any errors encountered while updating workflow transition rules for a workflow.
ruleUpdateErrors	JSON	Optional
ruleUpdateErrors (anyOf 1)	object	Alternative	A list of transition rule update errors, indexed by the transition rule ID. Any transition rule that appears here wasn't updated. Additional keys: see wildcard field
ruleUpdateErrors (anyOf 1).*	array	Additional keys	A list of transition rule update errors, indexed by the transition rule ID. Any transition rule that appears here wasn't updated. Unique items: true
ruleUpdateErrors (anyOf 1).*[]	string	Each item	A list of transition rule update errors, indexed by the transition rule ID. Any transition rule that appears here wasn't updated.
ruleUpdateErrors (anyOf 2)	null	Alternative
updateErrors	JSON	Optional
updateErrors (anyOf 1)	array	Alternative	The list of errors that specify why the workflow update failed. The workflow was not updated if the list contains any entries. Unique items: true
updateErrors (anyOf 1)[]	string	Each item	An error specifying why the workflow update failed.
updateErrors (anyOf 2)	null	Alternative
workflowId	JSON	Optional
workflowId (anyOf 1)	Model	Alternative	Expand Get workflow transition rule configurations — response body — values The list of items item workflow Id Properties that identify a workflow
workflowId (anyOf 2)	null	Alternative

Referenced models: Get workflow transition rule configurations — response body — values The list of items item workflow Id Properties that identify a workflow

Update workflow transition rule configurations — request body — body workflows item

Field	Type	Presence	Description and constraints
$	object	Root	A workflow with transition rules. Additional keys: not allowed
conditions	array	Optional	The list of conditions within the workflow.
conditions[]	Model	Each item	Expand Update workflow transition rule configurations — request body — body workflows item conditions item
postFunctions	array	Optional	The list of post functions within the workflow.
postFunctions[]	Model	Each item	Expand Update workflow transition rule configurations — request body — body workflows item conditions item
validators	array	Optional	The list of validators within the workflow.
validators[]	Model	Each item	Expand Update workflow transition rule configurations — request body — body workflows item conditions item
workflowId	Model	Required within parent	Expand Update workflow transition rule configurations — request body — body workflows item workflow Id

Referenced models: Update workflow transition rule configurations — request body — body workflows item conditions item, Update workflow transition rule configurations — request body — body workflows item workflow Id

Get workflow transition rule configurations — response body — values The list of items item workflow Id Properties that identify a workflow

Field	Type	Presence	Description and constraints
$	object	Root	Properties that identify a workflow.
draft	JSON	Optional
draft (anyOf 1)	boolean	Alternative	**Deprecated:** Whether the workflow is in the draft state. The 'draft' parameter will be removed from this API on [November 2, 2026](https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-3147).
draft (anyOf 2)	null	Alternative
name	JSON	Optional
name (anyOf 1)	string	Alternative	The name of the workflow.
name (anyOf 2)	null	Alternative

Update workflow transition rule configurations — request body — body workflows item conditions item

Field	Type	Presence	Description and constraints
$	object	Root	A workflow transition rule. Additional keys: not allowed
configuration	Model	Required within parent	Expand Update workflow transition rule configurations — request body — body workflows item conditions item configuration
id	string	Required within parent	The ID of the transition rule.
key	string	Required within parent	The key of the rule, as defined in the Connect or the Forge app descriptor. Read only: true
transition	Model	Optional	Expand Update workflow transition rule configurations — request body — body workflows item conditions item transition Read only: true

Referenced models: Update workflow transition rule configurations — request body — body workflows item conditions item configuration, Update workflow transition rule configurations — request body — body workflows item conditions item transition

Update workflow transition rule configurations — request body — body workflows item workflow Id

Field	Type	Presence	Description and constraints
$	object	Root	Properties that identify a workflow. Additional keys: not allowed
draft	boolean	Optional	**Deprecated:** Whether the workflow is in the draft state. The 'draft' parameter will be removed from this API on [November 2, 2026](https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-3147).
name	string	Required within parent	The name of the workflow.

Update workflow transition rule configurations — request body — body workflows item conditions item configuration

Field	Type	Presence	Description and constraints
$	object	Root	A rule configuration. Additional keys: not allowed
disabled	boolean	Optional	Whether the rule is disabled. Default: false
tag	string	Optional	A tag used to filter rules in [Get workflow transition rule configurations](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-transition-rules/#api-rest-api-3-workflow-rule-config-get). Maximum length: 255
value	string	Required within parent	Configuration of the rule, as it is stored by the Connect or the Forge app on the rule configuration page.

Update workflow transition rule configurations — request body — body workflows item conditions item transition

Field	Type	Presence	Description and constraints
$	object	Root	A workflow transition. Additional keys: not allowed
id	integer	Required within parent	The transition ID. Format: int32
name	string	Required within parent	The transition name.

Policy, approvals and errors

SDK function policy ID: atlassian.updateworkflowtransitionruleconfigurations. Catalog operation: updateworkflowtransitionruleconfigurations. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["manage:jira-configuration"]

Official provider source