POST /rest/api/2/workflow/transitions/{transitionId}/properties

Adds a property to a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see Transition properties and Workflow properties.

Permissions required: Administer Jira global permission.

Servers

Path parameters

Name Type Required Description
transitionId Integer Yes

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.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Query parameters

Name Type Required Description
key String Yes

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.

workflowMode String No

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

Possible values:

  • "live"
  • "draft"

Default value: "live"

workflowName String Yes

The name of the workflow that the transition belongs to.

Request body fields

Name Type Required Description
id String No

The ID of the transition property.

key String No

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

value String Yes

The value of the transition property.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.