Sign in

v4

latestOpenAPI 3.0.1Apache 2.02026-08-016169702.3 MB
Projects

Update project

Updates the project details of a project.

All parameters are optional in the body of the request. Schemes will only be updated if they are included in the request, any omitted schemes will be left unchanged.

Permissions required: Administer Jira global permission. is only needed when changing the schemes or project key. Otherwise you will only need Administer Projects project permission

put/rest/api/3/project/{projectIdOrKey}

Path parameters

projectIdOrKeystring required
Example:10001

The project ID or project key (case sensitive).

Query parameters

expandstring

Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that the project description, issue types, and project lead are included in all responses by default. Expand options include:

  • description The project description.
  • issueTypes The issue types associated with the project.
  • lead The project lead.
  • projectKeys All project keys associated with the project.

Request body

assigneeType'PROJECT_LEAD' | 'UNASSIGNED'

The default assignee when creating issues for this project.

avatarIdinteger

An integer value for the project's avatar.

categoryIdinteger

The ID of the project's category. A complete list of category IDs is found using the Get all project categories operation. To remove the project category from the project, set the value to -1.

descriptionstring

A brief description of the project.

issueSecuritySchemeinteger

The ID of the issue security scheme for the project, which enables you to control who can and cannot view issues. Use the Get issue security schemes resource to get all issue security scheme IDs.

keystring

Project keys must be unique and start with an uppercase letter followed by one or more uppercase alphanumeric characters. The maximum length is 10 characters.

leadstring

This parameter is deprecated because of privacy changes. Use leadAccountId instead. See the migration guide for details. The user name of the project lead. Cannot be provided with leadAccountId.

leadAccountIdstring

The account ID of the project lead. Cannot be provided with lead.

namestring

The name of the project.

notificationSchemeinteger

The ID of the notification scheme for the project. Use the Get notification schemes resource to get a list of notification scheme IDs.

permissionSchemeinteger

The ID of the permission scheme for the project. Use the Get all permission schemes resource to see a list of all permission scheme IDs.

releasedProjectKeysstring[]

Previous project keys to be released from the current project. Released keys must belong to the current project and not contain the current project key

urlstring

A link to information about this project, such as project documentation

Response

Returned if the project is updated.

archivedboolean

Whether the project is archived.

archivedDatestring date-time

The date when the project was archived.

assigneeType'PROJECT_LEAD' | 'UNASSIGNED'

The default assignee when creating issues for this project.

deletedboolean

Whether the project is marked as deleted.

deletedDatestring date-time

The date when the project was marked as deleted.

descriptionstring

A brief description of the project.

emailstring

An email address associated with the project.

expandstring

Expand options that include additional project details in the response.

favouriteboolean

Whether the project is selected as a favorite.

idstring

The ID of the project.

isPrivateboolean

Whether the project is private from the user's perspective. This means the user can't see the project or any associated issues.

keystring

The key of the project.

namestring

The name of the project.

projectTypeKey'software' | 'service_desk' | 'business'

The project type of the project.

propertiesobject

Map of project properties

retentionTillDatestring date-time

The date when the project is deleted permanently.

rolesobject

The name and self URL for each role defined in the project. For more information, see Create project role.

selfstring uri

The URL of the project details.

simplifiedboolean

Whether the project is simplified.

style'classic' | 'next-gen'

The type of the project.

urlstring

A link to information about this project, such as project documentation.

uuidstring uuid

Unique ID for next-gen projects.