Create a comment

POST

{team_id}

comments

Create a new comment

curl --request POST \
  --url https://api.superthread.com/v1/{team_id}/comments \
  --header 'Content-Type: application/json' \
  --data '
{
  "content": "Good point!",
  "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": "[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
      }
    },
    "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>"
          }
        ]
      }
    ],
    "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": "[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
            }
          },
          "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>"
                }
              ]
            }
          ],
          "parent_id": "1"
        }
      ]
    }
  }
}

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

schema

integer | null

Example:

1

card_id

string

Example:

"431"

page_id

string

Example:

"5"

context

string

Example:

"highlighted text"

Response

comment created

comment

object

Show child attributes

comment.id

string

Example:

"42"

comment.type

enum<string>

Available options:

comment,

child_comment

comment.content

string

Maximum string length: 102400

Example:

"Good point!"

comment.schema

integer

Example:

1

comment.page_id

string

Example:

"431"

comment.card_id

string

Example:

"433"

comment.user_id

string

Example:

"u-dsu0j19"

comment.user

Actor · object

describes a user or robot that created or updated a resource

Show child attributes

comment.user.user_id

string

Example:

"uDsu0j19"

comment.user.type

enum<string>

default:user

Available options:

user,

robot,

system

Example:

"user"

comment.user.source

ActorSource · object

describes the source of an actor

Show child attributes

comment.user.source.type

enum<string>

Available options:

oauth,

import,

email,

agent

Example:

"oauth"

comment.user.source.client_id

string

client ID if the resource was created via oauth2 app

Example:

"oczapier"

comment.user.source.import_id

string

import ID if the resource was created by an import

Example:

"bf1b9f76-3f95-42fc-bd7f-050b2f5f4197"

comment.user.source.agent_id

string

agent ID if the resource was created by an agent

Example:

"bf1b9f76-3f95-42fc-bd7f-050b2f5f4197"

comment.user.source.email_addr

string

email address if the resource was created via an email

Example:

"[email protected]"

comment.user.source.email_verified

boolean

whether the email sender was verified

Example:

false

comment.user_updated

Actor · object

describes a user or robot that created or updated a resource

Show child attributes

comment.user_updated.user_id

string

Example:

"uDsu0j19"

comment.user_updated.type

enum<string>

default:user

Available options:

user,

robot,

system

Example:

"user"

comment.user_updated.source

ActorSource · object

describes the source of an actor

Show child attributes

comment.user_updated.source.type

enum<string>

Available options:

oauth,

import,

email,

agent

Example:

"oauth"

comment.user_updated.source.client_id

string

client ID if the resource was created via oauth2 app

Example:

"oczapier"

comment.user_updated.source.import_id

string

import ID if the resource was created by an import

Example:

"bf1b9f76-3f95-42fc-bd7f-050b2f5f4197"

comment.user_updated.source.agent_id

string

agent ID if the resource was created by an agent

Example:

"bf1b9f76-3f95-42fc-bd7f-050b2f5f4197"

comment.user_updated.source.email_addr

string

email address if the resource was created via an email

Example:

"[email protected]"

comment.user_updated.source.email_verified

boolean

whether the email sender was verified

Example:

false

comment.team_id

string

Example:

"u-dsu0j19"

comment.time_created

integer<int64>

unix timestamp in seconds

Example:

1608742037016

comment.time_updated

integer<int64>

unix timestamp in seconds

Example:

1608742037016

comment.reactions

object[]

Show child attributes

comment.reactions.id

string

Example:

"sweat_smile"

comment.reactions.unicode

string

Reaction UTF-8 unicode value

comment.reactions.members

object[]

Show child attributes

comment.reactions.members.user_id

string

ID of user that reacted

comment.reactions.members.time_created

integer<int64>

unix timestamp in seconds

Example:

1608742037016

comment.reactions.members.variation

string

Variation of reaction

comment.context

string

Example:

"attach context to a comment"

comment.status

enum<string> | null

Available options:

resolved,

open,

orphaned

comment.participants

string[]

comment.children

object

Show child attributes

comment.children.cursor

string

required

Example:

"dmsjqh9d8w1hdjosjaasda"

comment.children.count

integer

required

Example:

14

comment.children.child_comments

object[]

Show child attributes

comment.children.child_comments.id

string

Example:

"42"

comment.children.child_comments.type

enum<string>

Available options:

comment,

child_comment

comment.children.child_comments.content

string

Maximum string length: 102400

Example:

"Good point!"

comment.children.child_comments.schema

integer

Example:

1

comment.children.child_comments.page_id

string

Example:

"431"

comment.children.child_comments.card_id

string

Example:

"433"

comment.children.child_comments.user_id

string

Example:

"u-dsu0j19"

comment.children.child_comments.user

Actor · object

describes a user or robot that created or updated a resource

Show child attributes

comment.children.child_comments.user.user_id

string

Example:

"uDsu0j19"

comment.children.child_comments.user.type

enum<string>

default:user

Available options:

user,

robot,

system

Example:

"user"

comment.children.child_comments.user.source

ActorSource · object

describes the source of an actor

Show child attributes

comment.children.child_comments.user.source.type

enum<string>

Available options:

oauth,

import,

email,

agent

Example:

"oauth"

comment.children.child_comments.user.source.client_id

string

client ID if the resource was created via oauth2 app

Example:

"oczapier"

comment.children.child_comments.user.source.import_id

string

import ID if the resource was created by an import

Example:

"bf1b9f76-3f95-42fc-bd7f-050b2f5f4197"

comment.children.child_comments.user.source.agent_id

string

agent ID if the resource was created by an agent

Example:

"bf1b9f76-3f95-42fc-bd7f-050b2f5f4197"

comment.children.child_comments.user.source.email_addr

string

email address if the resource was created via an email

Example:

"[email protected]"

comment.children.child_comments.user.source.email_verified

boolean

whether the email sender was verified

Example:

false

comment.children.child_comments.user_updated

Actor · object

describes a user or robot that created or updated a resource

Show child attributes

comment.children.child_comments.user_updated.user_id

string

Example:

"uDsu0j19"

comment.children.child_comments.user_updated.type

enum<string>

default:user

Available options:

user,

robot,

system

Example:

"user"

comment.children.child_comments.user_updated.source

ActorSource · object

describes the source of an actor

Show child attributes

comment.children.child_comments.user_updated.source.type

enum<string>

Available options:

oauth,

import,

email,

agent

Example:

"oauth"

comment.children.child_comments.user_updated.source.client_id

string

client ID if the resource was created via oauth2 app

Example:

"oczapier"

comment.children.child_comments.user_updated.source.import_id

string

import ID if the resource was created by an import

Example:

"bf1b9f76-3f95-42fc-bd7f-050b2f5f4197"

comment.children.child_comments.user_updated.source.agent_id

string

agent ID if the resource was created by an agent

Example:

"bf1b9f76-3f95-42fc-bd7f-050b2f5f4197"

comment.children.child_comments.user_updated.source.email_addr

string

email address if the resource was created via an email

Example:

"[email protected]"

comment.children.child_comments.user_updated.source.email_verified

boolean

whether the email sender was verified

Example:

false

comment.children.child_comments.team_id

string

Example:

"u-dsu0j19"

comment.children.child_comments.time_created

integer<int64>

unix timestamp in seconds

Example:

1608742037016

comment.children.child_comments.time_updated

integer<int64>

unix timestamp in seconds

Example:

1608742037016

comment.children.child_comments.reactions

object[]

Show child attributes

comment.children.child_comments.reactions.id

string

Example:

"sweat_smile"

comment.children.child_comments.reactions.unicode

string

Reaction UTF-8 unicode value

comment.children.child_comments.reactions.members

object[]

Show child attributes

comment.children.child_comments.reactions.members.user_id

string

ID of user that reacted

comment.children.child_comments.reactions.members.time_created

integer<int64>

unix timestamp in seconds

Example:

1608742037016

comment.children.child_comments.reactions.members.variation

string

Variation of reaction

comment.children.child_comments.parent_id

string

Example:

"1"

Edit a commentModifies the fields of an existing comment. Only the original author can modify comments. The request body should specify the fields to update, such as content, status, or context. Omitted fields will remain unchanged. The status field accepts the following values: resolved, open, orphaned.

⌘I

Create a new comment

curl --request POST \
  --url https://api.superthread.com/v1/{team_id}/comments \
  --header 'Content-Type: application/json' \
  --data '
{
  "content": "Good point!",
  "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": "[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
      }
    },
    "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>"
          }
        ]
      }
    ],
    "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": "[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
            }
          },
          "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>"
                }
              ]
            }
          ],
          "parent_id": "1"
        }
      ]
    }
  }
}

Get started

Users

Cards

Projects

Notes

Pages

Comments

Boards

Sprints

Spaces

Search

Path Parameters

Body

Response