Sample code for 30+ languages & platforms
CkPython Requires Chilkat v11.0.0+

Jira Cloud: Update Issue Fields

See more Jira Examples

Update an issue's summary and description, add a label, and remove another label. A field in fields replaces its value; operations in update can add or remove individual values. Do not put the same field in both objects.

Use GET /rest/api/3/issue/{issueIdOrKey}/editmeta to inspect editable fields and allowed operations for this issue. A commented custom-field assignment illustrates a single-line text field; replace its ID and use the value shape required by that field's schema. Updating fields does not perform a workflow transition.

The code uses an Atlassian account email and an API token without scopes with the site URL. For a scoped API token, keep Basic authentication and change baseUrl to https://api.atlassian.com/ex/jira/YOUR_CLOUD_ID. For OAuth2, use that gateway URL, omit Login/Password/BasicAuth, and set http.AuthToken to the access token. See API token authentication and OAuth2 authorization. The account must have permission for the operation; OAuth scopes do not grant additional Jira permissions.

Targets Jira Cloud. Jira Data Center has a separate REST API and may require different paths, authentication, or payloads.

Atlassian REST API documentation

Chilkat CkPython Downloads

CkPython
import sys
import chilkat

success = False

#  Assumes Chilkat is unlocked. See Global Unlock Sample.

http = chilkat.CkHttp()
http.put_RequireSslCertVerify(True)
http.put_BasicAuth(True)
#  Read these credentials from private application configuration.
http.put_Login("YOUR_ATLASSIAN_EMAIL")
http.put_Password("YOUR_API_TOKEN")
baseUrl = "https://your-domain.atlassian.net"
http.put_Accept("application/json")
url = chilkat.CkStringBuilder()
resp = chilkat.CkHttpResponse()
reply = chilkat.CkJsonObject()
issueKey = "PROJECT-123"
http.SetUrlVar("issueKey",issueKey)
request = chilkat.CkJsonObject()
request.UpdateString("fields.summary","Updated issue summary")
#  Jira v3 rich text is an Atlassian Document Format (ADF) document.
request.UpdateString("fields.description.type","doc")
request.UpdateInt("fields.description.version",1)
request.UpdateString("fields.description.content[0].type","paragraph")
request.UpdateString("fields.description.content[0].content[0].type","text")
request.UpdateString("fields.description.content[0].content[0].text","Updated description.")
request.UpdateString("update.labels[0].add","reviewed")
request.UpdateString("update.labels[1].remove","needs-review")
#  Optional: only after checking editmeta for your single-line text custom field.
#  ignore = request.UpdateString("fields.customfield_10042","Example value");
url.SetString(baseUrl)
url.Append("/rest/api/3/issue/{$issueKey}")
success = http.HttpJson("PUT",url.getAsString(),request,"application/json",resp)
if (resp.get_StatusCode() == 0):
    print("No HTTP response was received. Check connectivity and TLS settings.")
    sys.exit()

if ((success != True) or (resp.get_StatusCode() < 200) or (resp.get_StatusCode() >= 300)):
    print("Request failed. HTTP " + str(resp.get_StatusCode()))
    if (resp.get_StatusCode() == 429):
        print("Rate limited. Retry-After: " + resp.getHeaderField("Retry-After"))

    #  Inspect this response locally; it can contain private Jira data.
    print(resp.bodyStr())
    sys.exit()

#  Jira normally returns HTTP 204 with no JSON body.
print("Issue fields updated: " + issueKey)