POST /rest/api/2/workflowscheme/update

Updates company-managed and team-managed project workflow schemes. This API doesn't have a concept of draft, so any changes made to a workflow scheme are immediately available. When changing the available statuses for issue types, an asynchronous task migrates the issues as defined in the provided mappings.

Permissions required:

Administer Jira project permission to update all, including global-scoped, workflow schemes.
Administer projects project permission to update project-scoped workflow schemes.

Servers

https://your-domain.atlassian.net

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`id`	String	Yes	The ID of this workflow scheme.
`name`	String	Yes	The new name for this workflow scheme.
`statusMappingsByIssueTypeOverride[]`	Array	No	Overrides, for the selected issue types, any status mappings provided in `statusMappingsByWorkflows`. Status mappings are required when the new workflow for an issue type doesn't contain all statuses that the old workflow has. Status mappings can be provided by a combination of `statusMappingsByWorkflows` and `statusMappingsByIssueTypeOverride`.
`statusMappingsByIssueTypeOverride[].statusMappings[]`	Array	Yes	The list of status mappings.
`statusMappingsByIssueTypeOverride[].statusMappings[].newStatusId`	String	Yes	The ID of the status in the new workflow.
`statusMappingsByIssueTypeOverride[].statusMappings[].oldStatusId`	String	Yes	The ID of the status in the old workflow that isn't present in the new workflow.
`statusMappingsByIssueTypeOverride[].issueTypeId`	String	Yes	The ID of the issue type for this mapping.
`description`	String	Yes	The new description for this workflow scheme.
`statusMappingsByWorkflows[]`	Array	No	The status mappings by workflows. Status mappings are required when the new workflow for an issue type doesn't contain all statuses that the old workflow has. Status mappings can be provided by a combination of `statusMappingsByWorkflows` and `statusMappingsByIssueTypeOverride`.
`statusMappingsByWorkflows[].newWorkflowId`	String	Yes	The ID of the new workflow.
`statusMappingsByWorkflows[].oldWorkflowId`	String	Yes	The ID of the old workflow.
`statusMappingsByWorkflows[].statusMappings[]`	Array	Yes	The list of status mappings.
`statusMappingsByWorkflows[].statusMappings[].newStatusId`	String	Yes	The ID of the status in the new workflow.
`statusMappingsByWorkflows[].statusMappings[].oldStatusId`	String	Yes	The ID of the status in the old workflow that isn't present in the new workflow.
`defaultWorkflowId`	String	No	The ID of the workflow for issue types without having a mapping defined in this workflow scheme. Only used in global-scoped workflow schemes. If the `defaultWorkflowId` isn't specified, this is set to Jira Workflow (jira).
`version`	Object	Yes	The current version details of this workflow scheme.
`version.id`	String	No	The version UUID.
`version.versionNumber`	Integer	No	The version number.
`workflowsForIssueTypes[]`	Array	No	Mappings from workflows to issue types.
`workflowsForIssueTypes[].issueTypeIds[]`	Array	Yes	The issue types assigned to the workflow.
`workflowsForIssueTypes[].workflowId`	String	Yes	The ID of the workflow.

How to start integrating

Add HTTP Task to your workflow definition.
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.
Click Test request to test run your request to the API and see the API's response.