provider Workflow transition properties POST /rest/api/3/workflow/transitions/{transitionId}/properties
@utdk/jira /rest/api/3/workflow/transitions/{transitionId}/properties
Create workflow transition property
This will be removed on [June 1, 2026](https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-2570); add transition properties using [Bulk update workflows](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows/#api-rest-api-3-workflows-update-post) instead. Adds a property to a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see [Transition properties](https://confluence.atlassian.com/x/zIhKLg#Advancedworkflowconfiguration-transitionproperties) and [Workflow properties](https://confluence.atlassian.com/x/JYlKLg). **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
transitionId path required
The ID of the transition. To get the ID, view the workflow in text mode in the Jira admin settings. The ID is shown next to the transition.
integer
key query required
The key of the property being added, also known as the name of the property. Set this to the same value as the `key` defined in the request body.
string
workflowName query required
The name of the workflow that the transition belongs to.
string
workflowMode query
The workflow status. Set to *live* for inactive workflows or *draft* for draft workflows. Active workflows cannot be edited.
enum: live, draft

Try it

Authentication
Configure credentials for The Jira Cloud platform REST API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

createworkflowtransitionproperty
POST/rest/api/3/workflow/transitions/{transitionId}/properties
This will be removed on [June 1, 2026](https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-2570); add transition properties using [Bulk update workflows](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows/#api-rest-api-3-workflows-update-post) instead. Adds a property to a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see [Transition properties](https://confluence.atlassian.com/x/zIhKLg#Advancedworkflowconfiguration-transitionproperties) and [Workflow properties](https://confluence.atlassian.com/x/JYlKLg). **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters

required

The ID of the transition. To get the ID, view the workflow in text mode in the Jira admin settings. The ID is shown next to the transition.

required

The key of the property being added, also known as the name of the property. Set this to the same value as the `key` defined in the request body.

required

The name of the workflow that the transition belongs to.

The workflow status. Set to *live* for inactive workflows or *draft* for draft workflows. Active workflows cannot be edited.

Input

The ID of the transition property.

The key of the transition property. Also known as the name of the transition property.

required

The value of the transition property.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import jira from '@utdk/jira';

await jira.createworkflowtransitionproperty({
  "workflowMode": "live"
})