provider Workflow schemes POST /rest/api/3/workflowscheme/update
@utdk/jira /rest/api/3/workflowscheme/update
Update workflow scheme
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](#async) migrates the issues as defined in the provided mappings. **[Permissions](#permissions) required:** * *Administer Jira* project permission to update all, including global-scoped, workflow schemes. * *Administer projects* project permission to update project-scoped workflow schemes.

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.

updateschemes
POST/rest/api/3/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](#async) migrates the issues as defined in the provided mappings. **[Permissions](#permissions) required:** * *Administer Jira* project permission to update all, including global-scoped, workflow schemes. * *Administer projects* project permission to update project-scoped workflow schemes.

Input

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)*.

required

The new description for this workflow scheme.

required

The ID of this workflow scheme.

required

The new name for this workflow scheme.

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`.

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`.

required

The current version details of this workflow scheme.

Mappings from workflows to issue types.

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.updateschemes()