Interface UpdateProjectDetails

Details about the project.

interface UpdateProjectDetails {
    assigneeType?: "PROJECT_LEAD" | "UNASSIGNED";
    avatarId?: number;
    categoryId?: number;
    description?: string;
    issueSecurityScheme?: number;
    key?: string;
    lead?: string;
    leadAccountId?: string;
    name?: string;
    notificationScheme?: number;
    permissionScheme?: number;
    releasedProjectKeys?: string[];
    url?: string;
}

Properties

assigneeType? avatarId? categoryId? description? issueSecurityScheme? key? lead? leadAccountId? name? notificationScheme? permissionScheme? releasedProjectKeys? url?

Properties

OptionalassigneeType

assigneeType?: "PROJECT_LEAD" | "UNASSIGNED"

The default assignee when creating issues for this project.

OptionalavatarId

avatarId?: number

An integer value for the project's avatar.

OptionalcategoryId

categoryId?: number

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.

Optionaldescription

description?: string

A brief description of the project.

OptionalissueSecurityScheme

issueSecurityScheme?: number

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.

Optionalkey

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.

Optionallead

lead?: string

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.

Deprecated

OptionalleadAccountId

leadAccountId?: string

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

Optionalname

name?: string

The name of the project.

OptionalnotificationScheme

notificationScheme?: number

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

OptionalpermissionScheme

permissionScheme?: number

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.

OptionalreleasedProjectKeys

releasedProjectKeys?: string[]

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

Optionalurl

url?: string

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

Settings

Member Visibility

On This Page

Properties