POST /rest/api/2/universal_avatar/type/{type}/owner/{entityId}

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:

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/2/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:

Permissions required: Administer Jira global permission.

Servers

Path parameters

Name Type Required Description
entityId String Yes

The ID of the item the avatar is associated with.

type String Yes

The avatar type.

Possible values:

  • "issuetype"
  • "project"
  • "priority"

Query parameters

Name Type Required Description
size Integer Yes

The length of each side of the crop region.

Default value: 0

x Integer No

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

Default value: 0

y Integer No

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

Default value: 0

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.