Skip to main content
PATCH
Rename a review

Path Parameters

workspaceId
string<uuid>
required

Workspace identifier.

reviewId
string<uuid>
required

Unique identifier of the review.

Body

application/json

Request payload to rename a review (set its title).

Request payload to rename a review (set its title).

displayName
string

The new title (1-255 characters). Omitting the field leaves the current title unchanged.

Required string length: 1 - 255

Response

Response type for a review: a named discussion on a document with a manual sign-off lifecycle (0..N per document), opened explicitly. It carries a reviewStatus, a displayName, and its assignees (0..N reviewers); its stream is a [WorkspaceReviewEntry] timeline.

Response type for a review: a named discussion on a document with a manual sign-off lifecycle (0..N per document), opened explicitly. It carries a reviewStatus, a displayName, and its assignees (0..N reviewers); its stream is a [WorkspaceReviewEntry] timeline.

assignees
object[]
required

The reviewers assigned to this review (empty when unassigned).

author
object
required

Account that opened the review.

createdAt
string<date-time>
required

When the review was created.

displayName
string
required

The review's title.

documentId
string<uuid>
required

Document under review.

id
string<uuid>
required

Unique identifier of the review.

reviewStatus
required

The review's current status.

Allowed value: "needs_review"
updatedAt
string<date-time>
required

When the review was last updated.