Change request comments

Engage in threaded conversations on proposed changes.

This API powers the inline discussion around any new or updated documentation. Participate in comment threads and resolve them after reaching consensus.

The Comment object

Attributes

and

anyOptional

or

The Comment object

{
  "object": "comment",
  "id": "text",
  "postedBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  },
  "postedAt": "2026-07-21T19:57:39.931Z",
  "editedAt": "2026-07-21T19:57:39.931Z",
  "reactions": [
    {
      "emoji": "text",
      "count": 1,
      "users": [
        {
          "user": {
            "object": "user",
            "id": "text",
            "displayName": "text",
            "email": "text",
            "photoURL": "text",
            "urls": {
              "location": "https://example.com"
            }
          },
          "reactedAt": "2026-07-21T19:57:39.931Z"
        }
      ]
    }
  ],
  "replies": 1,
  "repliers": [
    {
      "updatedAt": "2026-07-21T19:57:39.931Z",
      "count": 1,
      "user": {
        "object": "user",
        "id": "text",
        "displayName": "text",
        "email": "text",
        "photoURL": "text",
        "urls": {
          "location": "https://example.com"
        }
      }
    }
  ],
  "body": {
    "markdown": "# Hello World\n\nThis is a markdown document linking to [another page](/pages/page_id).\n"
  },
  "target": {
    "node": {
      "id": "text"
    },
    "tableCell": {
      "record": "text",
      "definition": "text"
    },
    "changeRequest": "text",
    "review": "text",
    "page": {
      "id": "text"
    },
    "space": "text",
    "revision": "text"
  },
  "urls": {
    "location": "https://example.com"
  },
  "permissions": {
    "view": true,
    "edit": true,
    "reply": true,
    "delete": true
  },
  "status": "resolved",
  "resolvedAt": "2026-07-21T19:57:39.931Z",
  "resolvedBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  }
}