Function updateProject

updateProject(
    client: Client,
    parameters: {
        assigneeType?: string & {} | "PROJECT_LEAD" | "UNASSIGNED";
        avatarId?: number;
        categoryId?: number;
        description?: string;
        expand?: string;
        issueSecurityScheme?: number;
        key?: string;
        lead?: string;
        name?: string;
        notificationScheme?: number;
        permissionScheme?: number;
        projectIdOrKey: string;
        projectTemplateKey?: string;
        projectTypeKey?: string;
        url?: string;
    },
    options?: RequestOptions,
): Promise<
    {
        archived?: boolean;
        avatarUrls?: Record<string, string>;
        description?: string;
        id?: string;
        key?: string;
        name?: string;
        self?: string;
        [key: string]: unknown;
    },
>
Updates a project. Only non null values sent in JSON will be updated in the project. Values available for the assigneeType field are: "PROJECT_LEAD" and "UNASSIGNED".
Parameters
- client: Client
- parameters: {
      assigneeType?: string & {} | "PROJECT_LEAD" | "UNASSIGNED";
      avatarId?: number;
      categoryId?: number;
      description?: string;
      expand?: string;
      issueSecurityScheme?: number;
      key?: string;
      lead?: string;
      name?: string;
      notificationScheme?: number;
      permissionScheme?: number;
      projectIdOrKey: string;
      projectTemplateKey?: string;
      projectTypeKey?: string;
      url?: string;
  }
  - OptionalassigneeType?: string & {} | "PROJECT_LEAD" | "UNASSIGNED"
  - OptionalavatarId?: number
  - OptionalcategoryId?: number
  - Optionaldescription?: string
  - Optionalexpand?: string
    
    Parameters to expand
  - OptionalissueSecurityScheme?: number
  - Optionalkey?: string
  - Optionallead?: string
  - Optionalname?: string
  - OptionalnotificationScheme?: number
  - OptionalpermissionScheme?: number
  - projectIdOrKey: string
    
    Project id or project key
  - OptionalprojectTemplateKey?: string
  - OptionalprojectTypeKey?: string
  - Optionalurl?: string
- Optionaloptions: RequestOptions
Returns Promise<
    {
        archived?: boolean;
        avatarUrls?: Record<string, string>;
        description?: string;
        id?: string;
        key?: string;
        name?: string;
        self?: string;
        [key: string]: unknown;
    },
>
- Defined in src/server/api/projects.ts:194

Function updateProject

Parameters

`Optional`assigneeType?: string & {} | "PROJECT_LEAD" | "UNASSIGNED"

`Optional`avatarId?: number

`Optional`categoryId?: number

`Optional`description?: string

`Optional`expand?: string

`Optional`issueSecurityScheme?: number

`Optional`key?: string

`Optional`lead?: string

`Optional`name?: string

`Optional`notificationScheme?: number

`Optional`permissionScheme?: number

projectIdOrKey: string

`Optional`projectTemplateKey?: string

`Optional`projectTypeKey?: string

`Optional`url?: string

Returns Promise<
    {
        archived?: boolean;
        avatarUrls?: Record<string, string>;
        description?: string;
        id?: string;
        key?: string;
        name?: string;
        self?: string;
        [key: string]: unknown;
    },
>

Settings

Function updateProject

Parameters

OptionalassigneeType?: string & {} | "PROJECT_LEAD" | "UNASSIGNED"

OptionalavatarId?: number

OptionalcategoryId?: number

Optionaldescription?: string

Optionalexpand?: string

OptionalissueSecurityScheme?: number

Optionalkey?: string

Optionallead?: string

Optionalname?: string

OptionalnotificationScheme?: number

OptionalpermissionScheme?: number

projectIdOrKey: string

OptionalprojectTemplateKey?: string

OptionalprojectTypeKey?: string

Optionalurl?: string

Returns Promise< { archived?: boolean; avatarUrls?: Record<string, string>; description?: string; id?: string; key?: string; name?: string; self?: string; [key: string]: unknown; },>

Settings

`Optional`assigneeType?: string & {} | "PROJECT_LEAD" | "UNASSIGNED"

`Optional`avatarId?: number

`Optional`categoryId?: number

`Optional`description?: string

`Optional`expand?: string

`Optional`issueSecurityScheme?: number

`Optional`key?: string

`Optional`lead?: string

`Optional`name?: string

`Optional`notificationScheme?: number

`Optional`permissionScheme?: number

`Optional`projectTemplateKey?: string

`Optional`projectTypeKey?: string

`Optional`url?: string

Returns Promise<
{
archived?: boolean;
avatarUrls?: Record<string, string>;
description?: string;
id?: string;
key?: string;
name?: string;
self?: string;
[key: string]: unknown;
},
>