Skip to content

Function: updateProjectAvatar() ​

ts
function updateProjectAvatar(
   client, 
   parameters, 
   options?
): Promise<void>;

Defined in: src/cloud/api/projectAvatars.ts:19

Sets the avatar displayed for a project.

Use Load project avatar to store avatars against the project, before using this operation to set the displayed avatar.

Permissions required:Administer projects project permission.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ fileName?: string; id: string; isDeletable?: boolean; isSelected?: boolean; isSystemAvatar?: boolean; owner?: string; projectIdOrKey: string; urls?: Record<string, string>; }-
parameters.fileName?stringThe file name of the avatar icon. Returned for system avatars.
parameters.id?stringThe ID of the avatar.
parameters.isDeletable?booleanWhether the avatar can be deleted.
parameters.isSelected?booleanWhether the avatar is used in Jira. For example, shown as a project's avatar.
parameters.isSystemAvatar?booleanWhether the avatar is a system avatar.
parameters.owner?stringThe owner of the avatar. For a system avatar the owner is null (and nothing is returned). For non-system avatars this is the appropriate identifier, such as the ID for a project or the account ID for a user.
parameters.projectIdOrKey?stringThe ID or (case-sensitive) key of the project.
parameters.urls?Record<string, string>The list of avatar icon URLs.
options?RequestOptions-

Returns ​

Promise<void>