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

Jira Cloud: Move Issues into a Sprint or Backlog

See more Jira Examples

Move selected issue keys into a chosen sprint, or remove their active/future sprint assignments to return them to the backlog. Set moveToBacklog to choose exactly one operation; the example does not move issues back immediately after adding them.

Use board and sprint discovery to obtain the sprint ID. The target must be an active or future sprint. Each request supports at most 50 issues. Moving issues does not change their workflow status; completed-sprint history is retained. The account needs the applicable project and scheduling permissions. OAuth integrations need the Jira Software scopes specified by the selected endpoint.

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()
moveToBacklog = False
http.SetUrlVar("sprintId","YOUR_SPRINT_ID")
request = chilkat.CkJsonObject()
request.UpdateString("issues[0]","PROJECT-123")
request.UpdateString("issues[1]","PROJECT-124")
url.SetString(baseUrl)
if (moveToBacklog == True):
    url.Append("/rest/agile/1.0/backlog/issue")
else:
    url.Append("/rest/agile/1.0/sprint/{$sprintId}/issue")

success = http.HttpJson("POST",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()

print("Issue sprint assignments updated.")