Project versions

Update version

Changed on

Updates a project version.

This operation can be accessed anonymously.

Permissions required: Administer Jira global permission or Administer Projects project permission for the project that contains the version.

put/rest/api/3/version/{id}

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/rest/api/3/version/{id}
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: manage:jira-project
    • or none

Path parameters

idstring required

The ID of the version.

Request body

archivedboolean

Indicates that the version is archived. Optional when creating or updating a version.

descriptionstring

The description of the version. Optional when creating or updating a version. The maximum size is 16,384 bytes.

driverstring

The Atlassian account ID of the version driver. Optional when creating or updating a version. If the expand option driver is used, returns the Atlassian account ID of the driver.

expandstring

Use expand to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include:

  • operations Returns the list of operations available for this version.
  • issuesstatus Returns the count of issues in this version for each of the status categories to do, in progress, done, and unmapped. The unmapped property contains a count of issues with a status other than to do, in progress, and done.
  • driver Returns the Atlassian account ID of the version driver.
  • approvers Returns a list containing approvers for this version.

Optional for create and update.

idstring

The ID of the version.

moveUnfixedIssuesTostring uri

The URL of the self link to the version to which all unfixed issues are moved when a version is released. Not applicable when creating a version. Optional when updating a version.

namestring

The unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters.

overdueboolean

Indicates that the version is overdue.

projectstring

Deprecated. Use projectId.

projectIdinteger

The ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version.

releaseDatestring date

The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.

releasedboolean

Indicates that the version is released. If the version is released a request to release again is ignored. Not applicable when creating a version. Optional when updating a version.

selfstring uri

The URL of the version.

startDatestring date

The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.

userReleaseDatestring

The date on which work on this version is expected to finish, expressed in the instance's Day/Month/Year Format date format.

userStartDatestring

The date on which work on this version is expected to start, expressed in the instance's Day/Month/Year Format date format.

Response

Returned if the request is successful.

archivedboolean

Indicates that the version is archived. Optional when creating or updating a version.

descriptionstring

The description of the version. Optional when creating or updating a version. The maximum size is 16,384 bytes.

driverstring

The Atlassian account ID of the version driver. Optional when creating or updating a version. If the expand option driver is used, returns the Atlassian account ID of the driver.

expandstring

Use expand to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include:

  • operations Returns the list of operations available for this version.
  • issuesstatus Returns the count of issues in this version for each of the status categories to do, in progress, done, and unmapped. The unmapped property contains a count of issues with a status other than to do, in progress, and done.
  • driver Returns the Atlassian account ID of the version driver.
  • approvers Returns a list containing approvers for this version.

Optional for create and update.

idstring

The ID of the version.

moveUnfixedIssuesTostring uri

The URL of the self link to the version to which all unfixed issues are moved when a version is released. Not applicable when creating a version. Optional when updating a version.

namestring

The unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters.

overdueboolean

Indicates that the version is overdue.

projectstring

Deprecated. Use projectId.

projectIdinteger

The ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version.

releaseDatestring date

The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.

releasedboolean

Indicates that the version is released. If the version is released a request to release again is ignored. Not applicable when creating a version. Optional when updating a version.

selfstring uri

The URL of the version.

startDatestring date

The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.

userReleaseDatestring

The date on which work on this version is expected to finish, expressed in the instance's Day/Month/Year Format date format.

userStartDatestring

The date on which work on this version is expected to start, expressed in the instance's Day/Month/Year Format date format.

Changes

  • a4396bcf79c3Revision changes
    • info

      the request optional property became not read-only

    • info

      the response optional property became not read-only for the status