---
title: "PATCH /playwrightworkspaces/{workspaceId}/test-runs/{runId}"
method: PATCH
path: "/playwrightworkspaces/{workspaceId}/test-runs/{runId}"
---

# PATCH /playwrightworkspaces/{workspaceId}/test-runs/{runId}

`PATCH /playwrightworkspaces/{workspaceId}/test-runs/{runId}`

Creates/Updates a test-run for the workspace with given test-run id. Authorization required is Bearer JWT Access token provided by EntraID or Playwright Service.

## Path parameters

- `workspaceId` string, required
- `runId` string, required

## Query parameters

- `api-version` string, required

## Headers

- `x-ms-client-request-id` string, uuid

## Response `200`

The request has succeeded.

- TestRun — Model of a test-run used for tracking purpose.
  - `id` string, required — The test-run id in GUID format.
  - `displayName` string, required — The test-run display name.
  - `creatorId` string, required — The test-run creator's id.
  - `creatorName` string — The test-run creator's name.
  - `config` RunConfig — The run config.
    - `framework` RunFramework — The run framework.
      - `name` string — The framework name.
      - `version` string — The framework version.
      - `runnerName` string — The framework runner name.
    - `sdkLanguage` 'JAVASCRIPT' | 'TYPESCRIPT' | 'CSHARP' — The SDK Language used for run.
    - `maxWorkers` integer — The maximum number of workers required for the run.
  - `ciConfig` CiConfig — The run CI config.
    - `providerName` string — The CI provider name.
    - `branch` string — The CI branch.
    - `author` string — The CI author.
    - `commitId` string — The CI commit id.
    - `revisionUrl` string — The CI revision URL.
  - `summary` RunSummary, required — The run summary.
    - `status` 'RUNNING' | 'CLIENT_COMPLETE' | 'SERVER_COMPLETE', required — The run status.
    - `billableTime` integer — The run billable time.
    - `numBrowserSessions` integer — The total number of browser sessions allocated to the run.
    - `maxConcurrentBrowserSessions` integer — The highest number of browser sessions that were running at the same time during the run.
    - `startTime` string, date-time, required — The run start time as utcDateTime.
    - `endTime` string, date-time — The run end time as utcDateTime.
    - `duration` integer — The run duration.
    - `errorMessages` string[] — The list of error messages corresponding to the run.

## Other responses

- `201` — The request has succeeded and a new resource has been created as a result.
- `default` — An unexpected error response.

## Changes

- **2025-06-26** (2025-07-01-preview) `fbb0d3fa1f18` — 1 warning
  - deleted the `header` request parameter `x-ms-useragent`

[Change history](https://skmtc.dev/azure/apis/loadtestservice-playwright/changes/playwrightworkspaces/:workspaceId/test-runs/:runId/patch.md)

---

[API](https://skmtc.dev/azure/apis/loadtestservice-playwright.md) · [All operations](https://skmtc.dev/azure/apis/loadtestservice-playwright/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/azure/loadtestservice-playwright/revisions/fbb0d3fa1f18/schema)