Submit an approve or request-changes review for a change request
Submits a formal review decision (approved or changes-requested) on the change request, optionally with a rich-text comment. Use this to complete a review you were requested to perform. Only users who are requested reviewers or have space review permissions can submit a review.
post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
spaceIdstringRequiredPattern:
A unique entity identifier
^[a-zA-Z0-9_-]+$changeRequestIdstringRequiredPattern:
A unique entity identifier
^[a-zA-Z0-9_-]+$Body
statusstring · enumRequiredPossible values:
The status of the submitted review.
commentone ofOptional
Optionally, provide a comment along with the review.
or
or
object · EmptyOptional
Responses
201
A new review has been created.
application/json
post/spaces/{spaceId}/change-requests/{changeRequestId}/reviews
POST /v1/spaces/{spaceId}/change-requests/{changeRequestId}/reviews HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 145
{
"status": "changes-requested",
"comment": {
"markdown": "# Hello World\n\nThis is a markdown document linking to [another page](/pages/page_id).\n"
}
}201
A new review has been created.
{
"object": "change-request-review",
"id": "text",
"revision": "text",
"reviewer": {
"object": "user",
"id": "text",
"displayName": "text",
"email": "text",
"photoURL": "text",
"urls": {
"location": "https://example.com"
}
},
"requestedBy": {
"object": "user",
"id": "text",
"displayName": "text",
"email": "text",
"photoURL": "text",
"urls": {
"location": "https://example.com"
}
},
"status": "changes-requested",
"outdated": true,
"comment": {
"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"
}
}
},
"createdAt": "2026-01-01T00:00:00.000Z",
"updatedAt": "2026-01-01T00:00:00.000Z",
"urls": {
"location": "https://example.com"
}
}Last updated
Was this helpful?