Skip to main content
PATCH
/
{team_id}
/
lists
/
{list_id}
Update a list
curl --request PATCH \
  --url https://api.superthread.com/v1/{team_id}/lists/{list_id} \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "My list",
  "content": "<string>",
  "board_id": "2",
  "icon": "shield",
  "color": "<string>",
  "position": 0,
  "archived": true,
  "behavior": "backlog"
}'
{
  "list": {
    "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": "[email protected]",
        "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": "[email protected]",
        "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": "[email protected]",
            "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": "[email protected]",
            "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": [
              {
                "id": "4312",
                "title": "Some title",
                "content": "Some description",
                "checklist_id": "432",
                "user_id": "u-du9saoj1",
                "time_created": 1608742037016,
                "time_updated": 1608742037016,
                "checked": true
              }
            ]
          }
        ],
        "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": {
                "label": "<string>",
                "ref": "<string>"
              },
              "base": {
                "label": "<string>",
                "ref": "<string>"
              },
              "draft": true,
              "merged": true
            }
          }
        ],
        "hints": [
          {
            "type": "tag",
            "tag": {
              "name": "bug"
            },
            "relation": {
              "card": {
                "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"
              },
              "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": "[email protected]",
            "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": "[email protected]",
            "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": [
              {
                "id": "4312",
                "title": "Some title",
                "content": "Some description",
                "checklist_id": "432",
                "user_id": "u-du9saoj1",
                "time_created": 1608742037016,
                "time_updated": 1608742037016,
                "checked": true
              }
            ]
          }
        ],
        "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": {
                "label": "<string>",
                "ref": "<string>"
              },
              "base": {
                "label": "<string>",
                "ref": "<string>"
              },
              "draft": true,
              "merged": true
            }
          }
        ],
        "hints": [
          {
            "type": "tag",
            "tag": {
              "name": "bug"
            },
            "relation": {
              "card": {
                "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"
              },
              "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
        }
      }
    ]
  }
}

Path Parameters

​
team_id
string
required

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

​
list_id
string
required

List ID is a numerical string that identifies a List. This is externally referred to as a "Status".

Body

application/json

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

​
title
string | null
Example:

"My list"

​
content
string | null
​
board_id
string | null
Example:

"2"

​
icon
string | null
Example:

"shield"

​
color
string
​
position
integer | null

a position where the list should be placed in the board

Example:

0

​
archived
boolean | null

make this list archived/unarchived

Example:

true

​
behavior
enum<string>
Available options:
backlog,
committed,
started,
completed,
cancelled

Response

updated list response

​
list
object
⌘I