PUT /rest/api/2/project/{projectIdOrKey}

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

Servers

Path parameters

Name Type Required Description
projectIdOrKey String Yes

The project ID or project key (case sensitive).

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Query parameters

Name Type Required Description
expand String No

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 fields

Name Type Required Description
leadAccountId String No

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

lead String No

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.

description String No

A brief description of the project.

url String No

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

permissionScheme Integer No

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.

categoryId Integer No

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.

assigneeType String No

The default assignee when creating issues for this project.

Possible values:

  • "UNASSIGNED"
  • "PROJECT_LEAD"
avatarId Integer No

An integer value for the project's avatar.

name String No

The name of the project.

key String No

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.

notificationScheme Integer No

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

releasedProjectKeys[] Array No

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

issueSecurityScheme Integer No

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.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.