Skip to main content
PUT
/
api
/
v1
/
test-suites
/
{id}
Update Test Suite
curl --request PUT \
  --url https://api.example.com/api/v1/test-suites/{id}
Update an existing test suite’s name, description, or scenarios.

Request

PUT /api/v1/test-suites/{id}
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Path Parameters

ParameterTypeRequiredDescription
idstringYesUUID of the test suite

Body Parameters

At least one field is required.
ParameterTypeDescription
namestringNew display name
descriptionstringNew description
scenario_idsarrayNew array of scenario UUIDs

Response

Returns the updated test suite object.
FieldTypeDescription
idstringTest suite UUID
namestringDisplay name
descriptionstringDescription (or null)
scenario_idsarrayArray of scenario UUIDs
scenario_countnumberNumber of scenarios in the suite
created_atstringISO-8601 creation timestamp
updated_atstringISO-8601 last update timestamp

Examples

# Update name and description
curl -X PUT "https://app.preclinical.dev/api/v1/test-suites/uuid" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Emergency Triage v2",
    "description": "Updated emergency scenarios"
  }'

# Update scenarios
curl -X PUT "https://app.preclinical.dev/api/v1/test-suites/uuid" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "scenario_ids": ["new-scenario-1", "new-scenario-2"]
  }'

Success Response

{
  "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
  "name": "Emergency Triage v2",
  "description": "Updated emergency scenarios",
  "scenario_ids": ["scenario-uuid-1", "scenario-uuid-2"],
  "scenario_count": 2,
  "created_at": "2026-01-15T08:00:00Z",
  "updated_at": "2026-01-30T14:00:00Z"
}

Errors

CodeDescription
NOT_FOUNDTest suite not found
MISSING_REQUIRED_FIELDAt least one field is required
INVALID_FIELD_VALUEscenario_ids must be a non-empty array
ALREADY_EXISTSA test suite with this name already exists