v4

latestOpenAPI 3.0.1Apache 2.02026-08-016169702.3 MB
Avatars

Load avatar

Loads a custom avatar for a project, issue type or priority.

Specify the avatar's local file location in the body of the request. Also, include the following headers:

  • X-Atlassian-Token: no-check To prevent XSRF protection blocking the request, for more information see Special Headers.
  • Content-Type: image/image type Valid image types are JPEG, GIF, or PNG.

For example:
curl --request POST

--user email@example.com:<api_token>

--header 'X-Atlassian-Token: no-check'

--header 'Content-Type: image/< image_type>'

--data-binary "<@/path/to/file/with/your/avatar>"

--url 'https://your-domain.atlassian.net/rest/api/3/universal_avatar/type/{type}/owner/{entityId}'

The avatar is cropped to a square. If no crop parameters are specified, the square originates at the top left of the image. The length of the square's sides is set to the smaller of the height or width of the image.

The cropped image is then used to create avatars of 16x16, 24x24, 32x32, and 48x48 in size.

After creating the avatar use:

  • Update issue type to set it as the issue type's displayed avatar.
  • Set project avatar to set it as the project's displayed avatar.
  • Update priority to set it as the priority's displayed avatar.

Permissions required: Administer Jira global permission.

post/rest/api/3/universal_avatar/type/{type}/owner/{entityId}

Path parameters

type'project' | 'issuetype' | 'priority' required

The avatar type.

entityIdstring required

The ID of the item the avatar is associated with.

Query parameters

xinteger

The X coordinate of the top-left corner of the crop region.

yinteger

The Y coordinate of the top-left corner of the crop region.

sizeinteger required

The length of each side of the crop region.

Response

Returned if the request is successful.

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.