Overview
Theupdate() method allows you to modify an existing test after it has been created.
Parameters
The ID of the test to update.
New test name. Must be a non-empty string; leading and trailing whitespace are trimmed server-side.
Arbitrary JSON-serializable metadata for tracking purposes. Replaces the existing metadata wholesale. Pass
None to clear.Returns
Returns the updatedTest object.
Example
Use Cases
Replacing Metadata
Overwrite the metadata object on an existing test:Updating Name and Metadata Together
Notes
All fields except
test_id default to PydanticUndefined (from pydantic_core).
Omit a field (or pass PydanticUndefined) to leave it unchanged.
Pass None to explicitly clear an optional field.
Pass a value to update it.Related Methods
- Create Test - Create a new test
- Get Test - Retrieve a test by ID
- List Tests - List tests for a product
- Delete Test - Soft-delete a test