Atlassian · Schema

UpdateProjectDetails

Details about the project.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name	Type	Description
assigneeType	string	The default assignee when creating issues for this project.
avatarId	integer	An integer value for the project's avatar.
categoryId	integer	The ID of the project's category. A complete list of category IDs is found using the [Get all project categories](#api-rest-api-3-projectCategory-get) operation. To remove the project category from th
description	string	A brief description of the project.
issueSecurityScheme	integer	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](#api-rest-api-3-issuesecurityschemes-get) resourc
key	string	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.
lead	string	This parameter is deprecated because of privacy changes. Use `leadAccountId` instead. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-
leadAccountId	string	The account ID of the project lead. Cannot be provided with `lead`.
name	string	The name of the project.
notificationScheme	integer	The ID of the notification scheme for the project. Use the [Get notification schemes](#api-rest-api-3-notificationscheme-get) resource to get a list of notification scheme IDs.
permissionScheme	integer	The ID of the permission scheme for the project. Use the [Get all permission schemes](#api-rest-api-3-permissionscheme-get) resource to see a list of all permission scheme IDs.
url	string	A link to information about this project, such as project documentation

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UpdateProjectDetails",
  "title": "UpdateProjectDetails",
  "additionalProperties": false,
  "description": "Details about the project.",
  "properties": {
    "assigneeType": {
      "description": "The default assignee when creating issues for this project.",
      "enum": [
        "PROJECT_LEAD",
        "UNASSIGNED"
      ],
      "type": "string"
    },
    "avatarId": {
      "description": "An integer value for the project's avatar.",
      "format": "int64",
      "type": "integer"
    },
    "categoryId": {
      "description": "The ID of the project's category. A complete list of category IDs is found using the [Get all project categories](#api-rest-api-3-projectCategory-get) operation. To remove the project category from the project, set the value to `-1.`",
      "format": "int64",
      "type": "integer"
    },
    "description": {
      "description": "A brief description of the project.",
      "type": "string"
    },
    "issueSecurityScheme": {
      "description": "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](#api-rest-api-3-issuesecurityschemes-get) resource to get all issue security scheme IDs.",
      "format": "int64",
      "type": "integer"
    },
    "key": {
      "description": "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.",
      "type": "string"
    },
    "lead": {
      "description": "This parameter is deprecated because of privacy changes. Use `leadAccountId` instead. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. The user name of the project lead. Cannot be provided with `leadAccountId`.",
      "type": "string"
    },
    "leadAccountId": {
      "description": "The account ID of the project lead. Cannot be provided with `lead`.",
      "maxLength": 128,
      "type": "string"
    },
    "name": {
      "description": "The name of the project.",
      "type": "string"
    },
    "notificationScheme": {
      "description": "The ID of the notification scheme for the project. Use the [Get notification schemes](#api-rest-api-3-notificationscheme-get) resource to get a list of notification scheme IDs.",
      "format": "int64",
      "type": "integer"
    },
    "permissionScheme": {
      "description": "The ID of the permission scheme for the project. Use the [Get all permission schemes](#api-rest-api-3-permissionscheme-get) resource to see a list of all permission scheme IDs.",
      "format": "int64",
      "type": "integer"
    },
    "url": {
      "description": "A link to information about this project, such as project documentation",
      "type": "string"
    }
  },
  "type": "object"
}