ATatlassian
Workflow schemes

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 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.
post/rest/api/3/workflowscheme/update

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/rest/api/3/workflowscheme/update
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: manage:jira-configuration

Request body

defaultWorkflowIdstring

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

descriptionstring required

The new description for this workflow scheme.

idstring required

The ID of this workflow scheme.

namestring required

The new name for this workflow scheme.

Response

Returned if the request is successful and there is no asynchronous task.

unknown required

Changes

No recorded changes to this operation across all 31 revisions of this API.