Update Test Sample (v1)

Method & Path

PATCH /api/v1/workspace/:workspaceId/labs/test-samples/:testSampleId

Actual backend path: /v1/workspace/:workspaceId/labs/test-samples/:testSampleId

Description

Update an existing test sample in the workspace.

Authentication

Required: JWT token in Authorization header

Required Permissions:

• labs.manage

Headers

Header	Type	Required	Description
Authorization	string	Yes	Bearer token: Bearer <token>
Content-Type	string	Yes	application/json

Path Parameters

Parameter	Type	Required	Description
workspaceId	string	Yes	Workspace identifier (MongoDB ObjectId)
testSampleId	string	Yes	Test sample identifier (MongoDB ObjectId)

Request Body

{
  "sampleTypeTitle": "Blood - Whole Blood"
}

Field	Type	Required	Description
sampleTypeTitle	string	No	Test sample title (1-500 characters)

Response 200 OK

{
  "testSample": {
    "id": "507f1f77bcf86cd799439011",
    "workspaceId": "507f1f77bcf86cd799439012",
    "sampleTypeTitle": "Blood - Whole Blood",
    "createdAt": "2025-01-15T10:00:00.000Z",
    "updatedAt": "2025-01-15T11:00:00.000Z",
    "deletedAt": null
  }
}

Common Errors

400 Bad Request: Invalid request body

401 Unauthorized: Missing or invalid authentication token

403 Forbidden: Insufficient permissions (labs.manage required)

404 Not Found: Test sample or workspace not found

409 Conflict: Test sample with the same title already exists

422 Validation Error: Invalid workspace ID, test sample ID format, or validation errors