API Reference Checks

Update Check

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

Update a check’s title, project, sharing or bug-report fields. Workspace and resource permissions apply.

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

namestring

Updated check title.

isPublicboolean

Whether the check is publicly shared. Private checks require an eligible plan.

projectIdstring

Updated projectId. Must be a UUID.

statusIdstring

Updated statusId. Must be a UUID.

featureIdstring

Updated featureId. Must be a UUID.

featurestring

Updated feature.

preConditionstring

Updated preCondition.

idealBehaviorstring

Updated idealBehavior.

stepsToReproducestring

Updated stepsToReproduce.

severitystring

Updated bug severity.

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 check identifier.
`name`string \| null	Check title.
`type`string	Screenshot, recording or replay capture type.
`projectId`string \| null	Project containing this check.
`pageUrl`string \| null	URL where the check was captured.

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.