Skip to main content
PUT
/
{team_id}
/
sprints
/
settings
Set sprint settings
curl --request PUT \
  --url https://api.superthread.com/v1/{team_id}/sprints/settings \
  --header 'Content-Type: application/json' \
  --data '
{
  "statuses": [
    {
      "title": "To Do",
      "status": "started",
      "id": "688a7717-f1ea-4955-9f5f-6eca66e98f64"
    }
  ],
  "length": 14,
  "cooldown": 7,
  "start_day": 1,
  "enabled": true,
  "vcs_mapping": {
    "branch": "develop",
    "pr_draft": "41",
    "pr_open": "41",
    "pr_review_requested": "41",
    "pr_merged": "41",
    "pr_closed": "41"
  },
  "layout": "board",
  "card_cover_enabled": true
}
'
{
  "sprint_settings": {
    "statuses": [
      {
        "title": "To Do",
        "status": "started",
        "id": "688a7717-f1ea-4955-9f5f-6eca66e98f64"
      }
    ],
    "length": 14,
    "cooldown": 7,
    "start_day": 1,
    "enabled": true,
    "vcs_mapping": {
      "pr_draft": "41",
      "pr_open": "41",
      "pr_review_requested": "41",
      "pr_merged": "41",
      "pr_closed": "41",
      "branches": [
        {
          "name": "development",
          "pr_draft": "41",
          "pr_open": "41",
          "pr_review_requested": "41",
          "pr_merged": "41",
          "pr_closed": "41",
          "time_created": 1608742037016
        }
      ]
    },
    "layout": "board",
    "time_updated": 1608742037016,
    "user_updated": {
      "user_id": "uDsu0j19",
      "type": "user",
      "source": {
        "type": "oauth",
        "client_id": "oczapier",
        "import_id": "bf1b9f76-3f95-42fc-bd7f-050b2f5f4197",
        "agent_id": "bf1b9f76-3f95-42fc-bd7f-050b2f5f4197",
        "email_addr": "[email protected]",
        "email_verified": false
      }
    },
    "card_cover_enabled": true
  }
}

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