Forums

Articles
Create
cancel
Showing results for 
Search instead for 
Did you mean: 

How to automate the opening and closing of a Sprint via REST API?

Hernani Júnior August 29, 2024

 

 

Hello, community!

I am looking for a way to automate the start and end of Sprints in Jira using the REST API. I would like to know if anyone has implemented something similar and what the necessary steps would be to set up this automation. Additionally, where can I find the official documentation that addresses this specific topic?

Any help or guidance would be greatly appreciated!

Thank you!

1 answer

1 accepted

1 vote
Answer accepted
Anandhi Arumugam _Cprime_
Community Champion
August 30, 2024

Hi @Hernani Júnior 

You need to use the Update Sprint endpoint

https://your-domain.atlassian.net/rest/agile/1.0/sprint/{sprintId}

Please refer to the documentation https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint/#api-rest-agile-1-0-sprint-sprintid-put

  • A sprint can be started by updating the state to 'active'. This requires the sprint to be in the 'future' state and have a startDate and endDate set.
  • A sprint can be completed by updating the state to 'closed'. This action requires the sprint to be in the 'active' state. This sets the completeDate to the time of the request.

Hope this helps!

Suggest an answer

Log in or Sign up to answer
DEPLOYMENT TYPE
CLOUD
PERMISSIONS LEVEL
Product Admin
TAGS
AUG Leaders

Atlassian Community Events