For AI agents and LLMs: a machine-readable index is available at llms.txt. A plain-Markdown version of any documentation page is available by appending .md to its URL.
Skip to main content
Test Runs›Update Test Run Instance
TestMu AI
StatusCommunityBlog
Selenium Automation API
Automated Screenshots API
App Automation API (Real Devices)
Smart UI
Cypress Automation
User Management
Test Manager
HyperExecute
Accessibility Testing
Analytics
Performance Testing
Audit logs
Test Runs

Update Test Run Instance

Updates a single test run instance - its execution status, the remarks logged against it, and the user it is assigned to. All body fields are optional; send only the fields you want to change. Retrieve the test_instance_id from GET /api/v1/test-run/instances/{test_run_id}. To set assignee you need the numeric user ID, which you can look up with the "Get All Users" API in the User Management section of the API documentation.

PUT
/api/v1/test-run/instance/{test_instance_id}
Update Test Run Instance
curl --request PUT \
  --url "https://test-manager-api.lambdatest.com/api/v1/test-run/instance/{test_instance_id}" \
  --header "Authorization: Basic <encoded-value>" \
  --header "Content-Type: application/json" \
  --data '{
    "status": "Failed",
    "remarks": "<p>Test Instance marked failed and need retesting</p>",
    "assignee": 640220
  }'
{
  "message": "Test Run Instance updated successfully",
  "type": "Success"
}

Authorizations

Authorizationstringheaderrequired

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

test_instance_idstringrequired

ID of the test run instance to update.

Body

application/json
statusenum<string>

Execution status to set on the test run instance.

PassedFailedSkippedNot Started
remarksstring

Remarks logged against the instance. Accepts HTML markup - the Test Manager UI renders this as rich text, so wrap plain text in a tag such as <p>.

assigneeinteger

User ID of the assignee. This is the LambdaTest user ID, not an email or username, and it is not shown in the Test Manager UI. Look up the users in your organization with the "Get All Users" API in the User Management section of the API documentation (https://swagger-api-support.lambdatest.com/user_management/index.html#/Users/getAllUsers), then pass the id of the desired user from that response here.

Response

application/json

OK

messagestring
Example: "Test Run Instance updated successfully"
typestring
Example: "Success"
Update Test Run Instance
curl --request PUT \
  --url "https://test-manager-api.lambdatest.com/api/v1/test-run/instance/{test_instance_id}" \
  --header "Authorization: Basic <encoded-value>" \
  --header "Content-Type: application/json" \
  --data '{
    "status": "Failed",
    "remarks": "<p>Test Instance marked failed and need retesting</p>",
    "assignee": 640220
  }'
{
  "message": "Test Run Instance updated successfully",
  "type": "Success"
}