Archive a card

Update a card’s attributes or archive/unarchive it.

Archiving:

• If archived=true, the card is archived and other changes are ignored.
• If archived=false, an archived card is unarchived and other changes are ignored.

Attribute Updates:

• Update fields like title, priority, due_date, owner_id, estimate without affecting unspecified fields.

Fields not mentioned remain unchanged.

PATCH /{team_id}/cards/{card_id}

Update card attributes or archive/unarchive.

cURL

curl --request PATCH \
  --url https://api.superthread.com/v1/{team_id}/cards/{card_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "My Card",
  "board_id": "2",
  "list_id": "114",
  "project_id": "1",
  "sprint_id": "8",
  "owner_id": "<string>",
  "start_date": 1608742037016,
  "due_date": 1608742037016,
  "position": 5,
  "priority": 1,
  "estimate": 3,
  "time_estimate_seconds": 123,
  "time_remaining_seconds": 123,
  "archived": true
}
'

200

{
  "card": {
    "id": "2700",
    "type": "card",
    "icon": {
      "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
      "id": "<string>",
      "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": "[e-mail]",
        "email_verified": false,
        "on_behalf_of": "<string>"
      }
    },
    "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": "[e-mail]",
        "email_verified": false,
        "on_behalf_of": "<string>"
      }
    },
    "start_date": 1608742037016,
    "due_date": 1608742037016,
    "completed_date": 1608742037016,
    "time_created": 1608742037016,
    "time_updated": 1608742037016,
    "members": [
      {
        "user_id": "u-dsu0j19",
        "assigned_date": 1608742037016
      }
    ],
    "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",
        "icon": {
          "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
          "id": "<string>",
          "blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
          "color": "black",
          "emoji": "thumbsup"
        }
      }
    ],
    "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": [
      {
        "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
        },
        "generic": {
          "url": "<string>",
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "display_text": "<string>",
          "time_added": 1608742037016
        }
      }
    ],
    "hints": [
      {
        "type": "tag",
        "tag": {},
        "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,
    "time_estimate_seconds": 123,
    "time_remaining_seconds": 123,
    "epic": {
      "id": "e-123",
      "title": "Epic Title",
      "icon": {
        "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
        "id": "<string>",
        "blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
        "color": "black",
        "emoji": "thumbsup"
      }
    },
    "cover_image": {
      "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
      "id": "<string>",
      "blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
      "color": "black",
      "emoji": "thumbsup",
      "positionY": 123
    },
    "copied_from_card_id": "<string>",
    "form_id": "<string>",
    "suggested_branch_name": "<string>"
  }
}

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".

card_id · string · required

Card ID is a numerical string that identifies a card.

Body

application/json

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

title · string | null

Example:

"My Card"

board_id · string | null

Example:

"2"

list_id · string | null

Example:

"114"

project_id · string | null

Example:

"1"

sprint_id · string | null

sprint id

Example:

"8"

owner_id · string | null

start_date · integer<int64> | null

unix timestamp in seconds

Example:

1608742037016

due_date · integer<int64> | null

unix timestamp in seconds

Example:

1608742037016

position · integer | null

a position where the card should be placed in the list

Example:

5

priority · integer | null

Required range: 0 <= x <= 4

Example:

1

estimate · integer | null

effort estimation enum for the card. 0 is unset, 1 is least, 5 is greatest. will map to different values depending on project settings.

Required range: 0 <= x <= 5

Example:

3

time_estimate_seconds · integer | null

Original time estimate for the card in seconds. Pass 0 to clear.

time_remaining_seconds · integer | null

Remaining time estimate in seconds. Manual adjustment overrides the auto-decremented value.

archived · boolean | null

make this card archived/unarchived

Example:

true

cover_image · object

Show child attributes

Response

200

application/json

Updated card response

card · object

Show child attributes