POST /rest/api/2/project/{projectIdOrKey}/avatar2
Loads an avatar for a project.
Specify the avatar's local file location in the body of the request. Also, include the following headers:
X-Atlassian-Token: no-checkTo prevent XSRF protection blocking the request, for more information see Special Headers.Content-Type: image/image typeValid 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/2/project/{projectIdOrKey}/avatar2'
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 Set project avatar to set it as the project's displayed avatar.
Permissions required: Administer projects project permission.
Servers
- https://your-domain.atlassian.net
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
projectIdOrKey |
String | Yes |
The ID or (case-sensitive) key of the project. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
size |
Integer | No |
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
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.