Skip to main content
PATCH
/
{team_id}
/
comments
/
{comment_id}
Update an existing comment.
curl --request PATCH \
  --url https://api.superthread.com/v1/{team_id}/comments/{comment_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "content": "Sounds great!",
  "schema": 1,
  "context": "new highlighted text",
  "status": "resolved",
  "health_update": {
    "previous": "on_track",
    "new": "on_track",
    "time": 1608742037016
  }
}
'
{
  "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"
        }
      ]
    }
  }
}

Path Parameters

​
team_id
string
required

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

​
comment_id
string
required

Comment ID is a numerical string that identifies a Comment.

Body

application/json

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

​
content
string | null
Maximum string length: 102400
Example:

"Sounds great!"

​
schema
integer | null
Example:

1

​
context
string | null
Example:

"new highlighted text"

​
status
enum<string> | null
Available options:
resolved,
open,
orphaned
​
health_update
object

Metadata about a health status update

Response

updated comment response

​
comment
object