Skip to main content
PATCH
/
{team_id}
/
boards
/
{board_id}
Update a board
curl --request PATCH \
  --url https://api.superthread.com/v1/{team_id}/boards/{board_id} \
  --header 'Content-Type: application/json' \
  --data '{
  "project_id": "44",
  "title": "My Board",
  "content": "Some content",
  "icon": "shield",
  "color": "<string>",
  "image_urls": "<string>",
  "thumbnail_url": "https://s3.....com/thumbnail.png",
  "archived": true,
  "position": 3,
  "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
}'
{
  "board": {
    "id": "24",
    "project_id": "3",
    "team_id": "tDsu0j19",
    "title": "My Board",
    "content": "<string>",
    "icon": "shield",
    "color": "<string>",
    "image_urls": "<string>",
    "thumbnail_url": "https://s3.....com/thumbnail.png",
    "user_id": "u2erXoQq",
    "user_id_updated": "u2erXoQq",
    "user": {
      "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": "somebody@example.com",
        "email_verified": false
      }
    },
    "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": "somebody@example.com",
        "email_verified": false
      }
    },
    "time_created": 1608742037016,
    "time_updated": 1608742037016,
    "members": [
      {
        "user_id": "u-dsu0j19",
        "assigned_date": 1608742037016,
        "role": "admin"
      }
    ],
    "lists": [
      {
        "id": "41",
        "team_id": "tDsu0j19",
        "title": "My list",
        "content": "<string>",
        "behavior": "backlog",
        "board_id": "43",
        "user_id": "u981hdaT",
        "user": {
          "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": "somebody@example.com",
            "email_verified": false
          }
        },
        "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": "somebody@example.com",
            "email_verified": false
          }
        },
        "project_id": "5",
        "icon": "shield",
        "color": "<string>",
        "card_order": {},
        "total_cards": 5,
        "time_created": 1608742037016,
        "time_updated": 1608742037016,
        "cards": [
          {
            "id": "2700",
            "type": "card",
            "icon": {
              "type": "image",
              "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
              "blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
              "color": "black",
              "emoji": "thumbsup"
            },
            "team_id": "tDsu0j19",
            "title": "My Card",
            "content": "Some card content",
            "schema": 1,
            "collaboration": {
              "token": "<string>"
            },
            "status": "started",
            "priority": 1,
            "board_id": "12",
            "board_title": "<string>",
            "list_id": "41",
            "list_color": "<string>",
            "list_title": "<string>",
            "sprint_id": "4s12",
            "owner_id": "uR2dws11",
            "user_id": "uR2dws11",
            "user_id_updated": "u2erXoQq",
            "user": {
              "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": "somebody@example.com",
                "email_verified": false
              }
            },
            "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": "somebody@example.com",
                "email_verified": false
              }
            },
            "start_date": 1608742037016,
            "due_date": 1608742037016,
            "completed_date": 1608742037016,
            "time_created": 1608742037016,
            "time_updated": 1608742037016,
            "members": [
              {
                "user_id": "u-dsu0j19",
                "assigned_date": 1608742037016,
                "role": "admin"
              }
            ],
            "checklists": [
              {
                "id": "232",
                "title": "My Checklist",
                "content": "Some description",
                "card_id": "32",
                "user_id": "uG2sdaOn",
                "time_created": 1608742037016,
                "time_updated": 1608742037016,
                "items": [
                  {}
                ]
              }
            ],
            "checklist_order": {},
            "checklist_item_order": {},
            "parent_card": {
              "title": "Implement service requirements",
              "card_id": "42",
              "list_color": "<string>",
              "status": "started"
            },
            "child_cards": [
              {
                "title": "Create illustration for upcoming holidays",
                "card_id": "42",
                "user_id": "us4Fsfed",
                "project_id": "3",
                "board_id": "15",
                "board_title": "Ideas",
                "list_id": "55",
                "list_title": "Done",
                "list_color": "<string>",
                "status": "started",
                "archived": {
                  "user_id": "uDsu0j19",
                  "time_archived": 1608742037016
                }
              }
            ],
            "child_card_order": {},
            "linked_cards": [
              {
                "title": "Create illustration for upcoming holidays",
                "card_id": "42",
                "user_id": "42",
                "project_id": "3",
                "board_id": "15",
                "board_title": "Ideas",
                "list_id": "list 1",
                "list_title": "list 1",
                "status": "started",
                "archived": {
                  "user_id": "uDsu0j19",
                  "time_archived": 1608742037016
                },
                "linked_card_type": "blocks"
              }
            ],
            "archived": {
              "user_id": "uDsu0j19",
              "time_archived": 1608742037016
            },
            "archived_list": false,
            "archived_board": false,
            "tags": [
              {
                "id": "u-dsu0j19",
                "team_id": "u-dsu0j19",
                "project_id": "5",
                "name": "todo",
                "slug": "todo",
                "color": "blue",
                "total_cards": 17
              }
            ],
            "total_comments": 3,
            "total_files": 1,
            "is_watching": true,
            "is_bookmarked": true,
            "project_id": "<string>",
            "external_links": [
              {
                "type": "github_pull_request",
                "github_pull_request": {
                  "id": 123,
                  "number": 123,
                  "state": "<string>",
                  "title": "<string>",
                  "body": "<string>",
                  "html_url": "<string>",
                  "time_created": 1608742037016,
                  "time_updated": 1608742037016,
                  "time_closed": 1608742037016,
                  "time_merged": 1608742037016,
                  "head": {},
                  "base": {},
                  "draft": true,
                  "merged": true
                }
              }
            ],
            "hints": [
              {
                "type": "tag",
                "tag": {
                  "name": "bug"
                },
                "relation": {
                  "card": {},
                  "similarity": 0.8
                }
              }
            ],
            "estimate": 2,
            "epic": {
              "id": "e-123",
              "title": "Epic Title",
              "icon": {
                "type": "image",
                "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
                "blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
                "color": "black",
                "emoji": "thumbsup"
              }
            },
            "cover_image": {
              "type": "image",
              "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
              "blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
              "color": "black",
              "emoji": "thumbsup",
              "positionY": 123,
              "object_fit": "contain"
            }
          }
        ],
        "epics": [
          {
            "id": "2700",
            "type": "epic",
            "team_id": "tDsu0j19",
            "icon": {
              "type": "image",
              "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
              "blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
              "color": "black",
              "emoji": "thumbsup"
            },
            "title": "My Card",
            "schema": 1,
            "content": "Some card content",
            "collaboration": {
              "token": "<string>"
            },
            "list_id": "41",
            "list_color": "<string>",
            "list_title": "<string>",
            "status": "started",
            "priority": 1,
            "owner_id": "uR2dws11",
            "user_id": "uR2dws11",
            "user_id_updated": "u2erXoQq",
            "user": {
              "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": "somebody@example.com",
                "email_verified": false
              }
            },
            "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": "somebody@example.com",
                "email_verified": false
              }
            },
            "start_date": 1608742037016,
            "due_date": 1608742037016,
            "completed_date": 1608742037016,
            "time_created": 1608742037016,
            "time_updated": 1608742037016,
            "members": [
              {
                "user_id": "u-dsu0j19",
                "assigned_date": 1608742037016,
                "role": "admin"
              }
            ],
            "checklists": [
              {
                "id": "232",
                "title": "My Checklist",
                "content": "Some description",
                "card_id": "32",
                "user_id": "uG2sdaOn",
                "time_created": 1608742037016,
                "time_updated": 1608742037016,
                "items": [
                  {}
                ]
              }
            ],
            "checklist_order": {},
            "checklist_item_order": {},
            "child_cards": [
              {
                "title": "Create illustration for upcoming holidays",
                "card_id": "42",
                "user_id": "us4Fsfed",
                "project_id": "3",
                "board_id": "15",
                "board_title": "Ideas",
                "list_id": "55",
                "list_title": "Done",
                "list_color": "<string>",
                "status": "started",
                "archived": {
                  "user_id": "uDsu0j19",
                  "time_archived": 1608742037016
                }
              }
            ],
            "child_card_order": {},
            "linked_cards": [
              {
                "title": "Create illustration for upcoming holidays",
                "card_id": "42",
                "user_id": "42",
                "project_id": "3",
                "board_id": "15",
                "board_title": "Ideas",
                "list_id": "list 1",
                "list_title": "list 1",
                "status": "started",
                "archived": {
                  "user_id": "uDsu0j19",
                  "time_archived": 1608742037016
                },
                "linked_card_type": "blocks"
              }
            ],
            "archived": {
              "user_id": "uDsu0j19",
              "time_archived": 1608742037016
            },
            "archived_list": false,
            "tags": [
              {
                "id": "u-dsu0j19",
                "team_id": "u-dsu0j19",
                "project_id": "5",
                "name": "todo",
                "slug": "todo",
                "color": "blue",
                "total_cards": 17
              }
            ],
            "total_comments": 3,
            "total_files": 1,
            "is_watching": true,
            "external_links": [
              {
                "type": "github_pull_request",
                "github_pull_request": {
                  "id": 123,
                  "number": 123,
                  "state": "<string>",
                  "title": "<string>",
                  "body": "<string>",
                  "html_url": "<string>",
                  "time_created": 1608742037016,
                  "time_updated": 1608742037016,
                  "time_closed": 1608742037016,
                  "time_merged": 1608742037016,
                  "head": {},
                  "base": {},
                  "draft": true,
                  "merged": true
                }
              }
            ],
            "hints": [
              {
                "type": "tag",
                "tag": {
                  "name": "bug"
                },
                "relation": {
                  "card": {},
                  "similarity": 0.8
                }
              }
            ],
            "cover_image": {
              "type": "image",
              "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
              "blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
              "color": "black",
              "emoji": "thumbsup",
              "positionY": 123,
              "object_fit": "contain"
            }
          }
        ],
        "archived": {
          "user_id": "uDsu0j19",
          "time_archived": 1608742037016
        },
        "is_watching": true,
        "webhook_notifications": [
          {
            "webhook": {
              "destination_type": "slack_channel_webhook",
              "integration_id": "42"
            },
            "options": {
              "card_created": true
            }
          }
        ]
      }
    ],
    "list_order": {},
    "tags": [
      {
        "id": "u-dsu0j19",
        "team_id": "u-dsu0j19",
        "project_id": "5",
        "name": "todo",
        "slug": "todo",
        "color": "blue",
        "total_cards": 17
      }
    ],
    "archived": {
      "user_id": "uDsu0j19",
      "time_archived": 1608742037016
    },
    "is_watching": true,
    "is_bookmarked": 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",
    "email": {
      "email": "board+engineering-board-b2L2jKl@inbound.superthread.com",
      "active": true
    },
    "webhook_notifications": [
      {
        "webhook": {
          "destination_type": "slack_channel_webhook",
          "integration_id": "42"
        },
        "options": {
          "card_created": true,
          "card_moved": true,
          "card_commented": true,
          "card_due_date": true
        }
      }
    ],
    "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".

​
board_id
string
required

Board ID is a numerical string that identifies a Board.

Body

application/json

Board fields that need to be updated. All omitted fields are left unmodified.

​
project_id
string | null
Example:

"44"

​
title
string | null
Example:

"My Board"

​
content
string | null
Example:

"Some content"

​
icon
string | null
Example:

"shield"

​
color
string | null
​
image_urls
string | null
​
thumbnail_url
string | null
Example:

"https://s3.....com/thumbnail.png"

​
archived
boolean | null

make this board archived/unarchived

Example:

true

​
position
integer | null

a position where the board should be placed in the project

Example:

3

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

"board"

​
card_cover_enabled
boolean | null

whether cover images are enabled for cards in this board

Response

updated board response

​
board
object
⌘I