Skip to main content
PATCH
Permission Required: project:edit-tests
Apply a partial update to a test plan. The patch is deep-merged into the current test plan. Arrays — including test_items — are replaced wholesale.

Path Parameters

testPlanId
string
required
The test plan ID (UUID)

Request Body

patch
object
required
Partial test plan body. Supply only the fields you want to change. Cannot change the test plan id.

Response

Returns the updated test plan (same shape as Get Test Plan).

Authorizations

X-Api-Key
string
header
required

API key for authentication

Path Parameters

testPlanId
string<uuid>
required

Test plan ID (UUID)

projectId
string
required

The project ID. You can copy it from the project settings page or the project URL in the dashboard.

Body

application/json
patch
object
required

Partial test plan body. Object fields are deep-merged; arrays (including test_items) are replaced wholesale.

Response

Test plan updated

id
string<uuid>

Unique identifier for the test plan

project_id
string<uuid>

Project the test plan belongs to

name
string

Test plan name

created_at
string<date-time> | null
created_by
string | null
modified_at
string<date-time> | null
modified_by
string | null
slots
object[]

Extra deployment slots of a cross-platform test plan (read-only via the API; managed in the test plan editor). Their indices key slot_deployment_configs when starting the plan; slot 1 is the implicit default slot.

default_slot_name
string | null

Optional display name of the implicit default slot (slot 1). Read-only via the API.

test_items
object[]

Ordered list of tests in this plan