Update the content or status of a change request comment

Replaces the body or status of an existing change request comment. Use this to edit the text of a comment you previously posted, or to resolve/reopen a comment thread. Only the comment author or space admins can update a comment.

Available in MCP

put

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

changeRequestIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

commentIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

Body

resolvedbooleanOptional

Whether the comment is resolved or not.

bodyone ofOptional

Content of the comment.

or

or

object · EmptyOptional

addedReactionsstring[]Optional

Reactions to add to the comment.

removedReactionsstring[]Optional

Reactions to remove from the comment.

Responses

200

The comment was updated.

application/json

and

anyOptional

or

put/spaces/{spaceId}/change-requests/{changeRequestId}/comments/{commentId}

PUT /v1/spaces/{spaceId}/change-requests/{changeRequestId}/comments/{commentId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 183

{
  "resolved": true,
  "body": {
    "markdown": "# Hello World\n\nThis is a markdown document linking to [another page](/pages/page_id).\n"
  },
  "addedReactions": [
    "text"
  ],
  "removedReactions": [
    "text"
  ]
}

200

The comment was updated.

{
  "object": "comment",
  "id": "text",
  "postedBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  },
  "postedAt": "2026-01-01T00:00:00.000Z",
  "editedAt": "2026-01-01T00:00:00.000Z",
  "reactions": [
    {
      "emoji": "text",
      "count": 1,
      "users": [
        {
          "user": {
            "object": "user",
            "id": "text",
            "displayName": "text",
            "email": "text",
            "photoURL": "text",
            "urls": {
              "location": "https://example.com"
            }
          },
          "reactedAt": "2026-01-01T00:00:00.000Z"
        }
      ]
    }
  ],
  "replies": 1,
  "repliers": [
    {
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "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-01-01T00:00:00.000Z",
  "resolvedBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  }
}