Skip to main content
POST
/
{team_id}
/
cards
Create a new card
curl --request POST \
  --url https://api.superthread.com/v1/{team_id}/cards \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "My Card",
  "list_id": "114",
  "content": "Some card content",
  "content_format": "html",
  "schema": 1,
  "start_date": 1608742037016,
  "due_date": 1608742037016,
  "board_id": "5",
  "project_id": "1",
  "sprint_id": "8",
  "owner_id": "<string>",
  "members": [
    {
      "user_id": "u-dsu0j19",
      "role": "admin"
    }
  ],
  "priority": 1,
  "estimate": 3,
  "parent_card_id": "<string>",
  "epic_id": "<string>",
  "board_email_ref": "b291eKoaaLn5",
  "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
    }
  },
  "checklists": [
    {
      "title": "My Checklist",
      "items": [
        {
          "title": "Some title",
          "content": "Some description",
          "checked": false
        }
      ]
    }
  ],
  "form_id": "<string>",
  "form_requester_user_id": "<string>"
}
'
{
  "card": {
    "id": "2700",
    "type": "card",
    "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": [
          {
            "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"
    },
    "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".

Body

application/json

Card object that needs to be created

​
title
string
required
Example:

"My Card"

​
list_id
string
required
Example:

"114"

​
content
string
Maximum string length: 102400
Example:

"Some card content"

​
content_format
enum<string>
default:html

Format of the content field. When set to 'markdown', the server converts the content from GitHub Flavored Markdown to HTML before storage. Defaults to 'html'.

Available options:
html,
markdown
​
schema
integer | null
Example:

1

​
start_date
integer<int64>

unix timestamp in seconds

Example:

1608742037016

​
due_date
integer<int64>

unix timestamp in seconds

Example:

1608742037016

​
board_id
string
Example:

"5"

​
project_id
string
Example:

"1"

​
sprint_id
string
Example:

"8"

​
owner_id
string | null
​
members
object[]
​
priority
integer | null
Required range: 0 <= x <= 4
Example:

1

​
estimate
integer | null

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

Required range: 1 <= x <= 5
Example:

3

​
parent_card_id
string | null

Optional card ID to set as parent

​
epic_id
string | null

Optional epic ID to add card to

​
board_email_ref
string | null

Optional Board Email reference when creating a card from an email

Example:

"b291eKoaaLn5"

​
user
Actor · object

describes a user or robot that created or updated a resource

​
cover_image
object
​
checklists
object[] | null

Optionally specify checklist(s) to create and add to the card

​
form_id
string

ID of the form that created this card, if any

​
form_requester_user_id
string

ID of the user that created this card from form submission

Response

Card created

​
card
object