Skip to main content
POST
/
{team_id}
/
comments
Create a new comment
curl --request POST \
  --url https://api.superthread.com/v1/{team_id}/comments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "content": "Good point!",
  "content_format": "html",
  "schema": 1,
  "card_id": "431",
  "page_id": "5",
  "context": "highlighted text"
}
'
{
  "comment": {
    "id": "42",
    "type": "comment",
    "content": "Good point!",
    "schema": 1,
    "page_id": "431",
    "card_id": "433",
    "user_id": "u-dsu0j19",
    "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
      }
    },
    "team_id": "u-dsu0j19",
    "time_created": 1608742037016,
    "time_updated": 1608742037016,
    "reactions": [
      {
        "id": "sweat_smile",
        "unicode": "<string>",
        "members": [
          {
            "user_id": "<string>",
            "time_created": 1608742037016,
            "variation": "<string>"
          }
        ]
      }
    ],
    "health_update_metadata": {
      "previous": "on_track",
      "new": "on_track",
      "time": 1608742037016
    },
    "context": "attach context to a comment",
    "status": "resolved",
    "participants": [
      "<string>"
    ],
    "children": {
      "cursor": "dmsjqh9d8w1hdjosjaasda",
      "count": 14,
      "child_comments": [
        {
          "id": "42",
          "type": "comment",
          "content": "Good point!",
          "schema": 1,
          "page_id": "431",
          "card_id": "433",
          "user_id": "u-dsu0j19",
          "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
            }
          },
          "team_id": "u-dsu0j19",
          "time_created": 1608742037016,
          "time_updated": 1608742037016,
          "reactions": [
            {
              "id": "sweat_smile",
              "unicode": "<string>",
              "members": [
                {
                  "user_id": "<string>",
                  "time_created": 1608742037016,
                  "variation": "<string>"
                }
              ]
            }
          ],
          "health_update_metadata": {
            "previous": "on_track",
            "new": "on_track",
            "time": 1608742037016
          },
          "parent_id": "1"
        }
      ]
    }
  }
}

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

Comment object that needs to be created

​
content
string
required
Maximum string length: 102400
Example:

"Good point!"

​
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

​
card_id
string
Example:

"431"

​
page_id
string
Example:

"5"

​
context
string
Example:

"highlighted text"

​
health_update
object

Metadata about a health status update

Response

comment created

​
comment
object