Skip to main content
PUT
Set sprint settings

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

team_id
string
required

Team ID is an alphanumerical string that identifies a Team. This is externally referred to as a "Workspace".

Query Parameters

project_id
string
required

Project ID is a numerical string that identifies a Project. This is externally referred to as a "Space".

Body

application/json

Sprint settings object

statuses
object[]
required

ordered list of statuses for the sprint

length
enum<integer>
required

length of the sprint in days

Available options:
7,
14,
21,
28,
35,
42,
49,
56
Example:

14

cooldown
enum<integer>
required

length of the cooldown period in days

Available options:
0,
7,
14,
21,
28
Example:

7

start_day
enum<integer>
required

day of the week to start the sprint (0 = Sunday, 1 = Monday, ..., 6 = Saturday)

Available options:
0,
1,
2,
3,
4,
5,
6
Example:

1

enabled
boolean
required

whether sprints are enabled for the project

Example:

true

vcs_mapping
object
layout
enum<string> | null
Available options:
board,
list,
timeline,
calendar
Example:

"board"

card_cover_enabled
boolean

whether card covers are enabled for the project

Response

Updated sprint settings

sprint_settings
object