API Reference Comments

Update Comment

PATCHhttps://api-v2.crosscheck.cloud/api/v1/comments/{id}

Update a comment you are permitted to edit. Optional mentions can be supplied as an array of user UUIDs.

Authentication

Send a valid Crosscheck session JWT in the Authorization: Bearer YOUR_SESSION_TOKEN header. Workspace endpoints use the active workspace in your session. MCP OAuth tokens are not accepted here.

Path Parameters

idstringrequired

The resource UUID.

Body Parameters

application/json

bodystringrequired

Comment text, between 1 and 5,000 characters.

Headers

Accept

JSON request and response format.

application/json

Authorization

A valid session JWT from Crosscheck authentication.

Bearer YOUR_SESSION_TOKEN

Content-Type

JSON request and response format.

application/json

Responses

200 OK

`id`string · uuid	Unique comment identifier.
`checkId`string · uuid	Check the comment belongs to.
`body`string	Comment text.
`createdBy`string · uuid	Comment author identifier.
`timestamp`number \| null	Position in a recording.
`imagePoint`object \| null	Normalized image coordinates, x and y from 0 to 1.

400 Invalid request

The API returns success, error, code and statusCode. Validation errors also include details. Select this status in the example panel to inspect the shape.

401 Authentication required

The API returns success, error, code and statusCode. Validation errors also include details. Select this status in the example panel to inspect the shape.

403 Insufficient permissions

The API returns success, error, code and statusCode. Validation errors also include details. Select this status in the example panel to inspect the shape.

404 Resource not found

The API returns success, error, code and statusCode. Validation errors also include details. Select this status in the example panel to inspect the shape.

Selected fields and abbreviated examples are shown. Additional fields and error codes depend on the resource, permissions, plan and retention state.