Issues

Archive issue(s) by issue ID/key

Changed on

Enables admins to archive up to 1000 issues in a single request using issue ID/key, returning details of the issue(s) archived in the process and the errors encountered, if any.

Note that:

  • you can't archive subtasks directly, only through their parent issues
  • you can only archive issues from software, service management, and business projects

Permissions required: Jira admin or site admin: global permission

License required: Premium or Enterprise

Signed-in users only: This API can't be accessed anonymously.

put/rest/api/3/issue/archive

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/rest/api/3/issue/archive
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: write:jira-work
    • or none

Request body

issueIdsOrKeysstring[]

Response

Returned if there is at least one valid issue to archive in the request. The return message will include the count of archived issues and subtasks, as well as error details for issues which failed to get archived.

numberOfIssuesUpdatedinteger

Changes

  • 6abe311e7b55Revision changes
    • info

      added the optional property / to the response with the status