Function: updateProject()

function updateProject(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  archived?: boolean;
  avatarUrls?: Record<string, string>;
  description?: string;
  id?: string;
  key?: string;
  name?: string;
  self?: string;
}>;

Defined in: src/server/api/projects.ts:194

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

Parameter	Type	Description
client	Client	-
parameters	{ assigneeType?: string & object | "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; }	-
parameters.assigneeType?	string & object | "PROJECT_LEAD" | "UNASSIGNED"	-
parameters.avatarId?	number	-
parameters.categoryId?	number	-
parameters.description?	string	-
parameters.expand?	string	Parameters to expand
parameters.issueSecurityScheme?	number	-
parameters.key?	string	-
parameters.lead?	string	-
parameters.name?	string	-
parameters.notificationScheme?	number	-
parameters.permissionScheme?	number	-
parameters.projectIdOrKey?	string	Project id or project key
parameters.projectTemplateKey?	string	-
parameters.projectTypeKey?	string	-
parameters.url?	string	-
options?	RequestOptions	-

Returns

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