Project avatars

Set project avatar

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.

put/rest/api/2/project/{projectIdOrKey}/avatar

Request

  • Base URL: https://your-domain.atlassian.net
  • URL: https://your-domain.atlassian.net/rest/api/2/project/{projectIdOrKey}/avatar
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://auth.atlassian.com/authorize, token URL https://auth.atlassian.com/oauth/token, scopes: manage:jira-project)
    • none

Path parameters

projectIdOrKeystring required

The ID or (case-sensitive) key of the project.

Request body

fileNamestring

The file name of the avatar icon. Returned for system avatars.

idstring required

The ID of the avatar.

isDeletableboolean

Whether the avatar can be deleted.

isSelectedboolean

Whether the avatar is used in Jira. For example, shown as a project's avatar.

isSystemAvatarboolean

Whether the avatar is a system avatar.

ownerstring

The 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.

urlsobject

The list of avatar icon URLs.

Response

Returned if the request is successful.

unknown required

Changes

No recorded changes to this operation across all 26 revisions of this API.