nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

How to add labels to Jira via Rest API

Devi Foskett

I would like to be able to add labels to a Jira using rest apis. I am using javascript currently to create an issue. I do not know the json required to create the label and need help figuring that out. I use only javascript and json for this thank you! When using postman there is a 415 error when I add "Labels":["Test"] to create a label.

Javascript&colon;

var xhr = new XMLHttpRequest();
 xhr.open(method, url);
 xhr.setRequestHeader("Content-Type","application/json");
 labels = ' {"fields": { "project": { "key": "'+ projectKey +'" }, "labels":["sd_reviewed", "ta_reviewed", "Reviewed", "Functional"]}} ';
 xhr.onreadystatechange = function() {
 if (xhr.readyState === 4 && xhr.status == 200) {
 console.log(xhr.responseText);
 }
 }; 

 xhr.send(labels);

Accepted answers

All comments

Warren_mz9b4z

Hi @Devi Foskett

Within the JSON, this is the format of adding a label

 "labels": [
 "Testing"
 ]

Hope this helps you

Devi Foskett

In postman this will return a 415 error and not work.

Devi Foskett

@Warren I have tried the code mentioned above with no avail. If you would like to see code to better understand what I am trying to accomplish I can add it above.

Warren_mz9b4z

Are you trying to

create an issue and set the label at the same time? If so, you're missing the issuetype. You also need to pass in values for EVERY mandatory field
add a label to an existing issue?

What error do you get using your javascript?

Below is what my JSON looks like to create an issue and set it's label

{
 "fields": {
 "project": {
 "key": "DS"
 },
 "summary": "Post Refresh work",
 "issuetype": {
 "name": "Task"
 },
 "labels": [
 "Label1",
 "Label2"
 ]
 }
}

Alin_Gabriel_Draghici

Reposting cause my edit dissapeared (?)

Endpoint: https://YourJiraInstance.com/rest/api/2/issue/issue-id-right-here

Body: {"update":{"labels":[{"add":"this-is-the-label-you're-adding"}]}}

POST method, basic AUTH

Cristina Donaldson

Thanks, this was very helpful!

Andrew Januszak

Per REST API Doc (https://docs.atlassian.com/software/jira/docs/api/REST/8.22.4/#issue-editIssue) the syntax is:

"labels":[{"add":"triaged"},{"remove":"blocker"}]}

In your case, I believe it would be:

"labels":[{"add":"sd_reviewed", "ta_reviewed", "Reviewed", "Functional"}]

unknown

Works with this payload, using PUT method as Warren mentions below.. Thanks!

Tomer Ben Arye

nope...
This one works:

{ "update": { "labels": [ { "add": "lable1" }, { "add": "label2" } ] } }

Tomer Ben Arye

PUT method.

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/#api-rest-api-3-issue-issueidorkey-put

/rest/api/3/issue/{issueIdOrKey}

{
"update": {
"labels": [
{
"add": "bump1"
},
{
"add": "no_sf_case_id"
}
]
}
}

Fadi Hawli

As of now I thought the only way you can create labels is by passing the issue key and then adding a label against the issue key. If you do not use an issue the api will not work. Has anyone solved this by being able to create labels without reference to an issue key?

Tomer Ben Arye

But I gave you the option to enter KEY or ID...

Roman Wolf

Hi @Fadi Hawli ,

as per my understanding the label concept in JIRA is different from what you expect.

You expect labels to be an independent entity in JIRA, like components or versions.

In fact labels just exist as an attribute of an issue. When you remove a label from all the issues the label is gone and cannot be found anywhere.

That explains why it is mandatory to provide an issue key.

Hope this helps, Roman

Welcome!

It looks like you're new here. Sign in or register to get started.

Quick Links

Find more posts tagged with

jira

rest-api

api

developer

label

javascript

json