Skip to main content
PATCH
/
test-plans
/
{testPlanId}
curl -X PATCH "https://nunu.ai/api/v1/test-plans/b3f1a2c4-5d6e-7f8a-9b0c-1d2e3f4a5b6c" \
  -H "X-Api-Key: YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "patch": { "name": "Nightly Smoke v2" }
  }'

{
  "id": "b3f1a2c4-5d6e-7f8a-9b0c-1d2e3f4a5b6c",
  "project_id": "test",
  "name": "Nightly Smoke v2",
  "test_items": [ { "...": "..." } ],
  "...": "..."
}

Documentation Index

Fetch the complete documentation index at: https://api-docs.nunu.ai/llms.txt

Use this file to discover all available pages before exploring further.

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). 
curl -X PATCH "https://nunu.ai/api/v1/test-plans/b3f1a2c4-5d6e-7f8a-9b0c-1d2e3f4a5b6c" \
  -H "X-Api-Key: YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "patch": { "name": "Nightly Smoke v2" }
  }'

{
  "id": "b3f1a2c4-5d6e-7f8a-9b0c-1d2e3f4a5b6c",
  "project_id": "test",
  "name": "Nightly Smoke v2",
  "test_items": [ { "...": "..." } ],
  "...": "..."
}

Authorizations

​
X-Api-Key
string
header
required

API key for authentication

Path Parameters

​
testPlanId
string<uuid>
required

Test plan ID (UUID)

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
​
test_items
object[]

Ordered list of tests in this plan