Skip to main content
PATCH
Update test plan

Path Parameters

testPlanShortId
string
required

Body

application/json
name
string
Required string length: 1 - 200
description
string
Maximum string length: 2000
reviewInstructions
string | null

Set to null to clear

Maximum string length: 4000
addTestCaseIds
string[]

Project test case IDs to add to the plan. Test cases already in the plan are ignored.

Maximum array length: 500
removeTestCaseIds
string[]

Project test case IDs to remove from the plan. The test cases themselves are kept.

Maximum array length: 500
projectShortId
string

Target a specific project by its prefixed short ID (proj-slug_shortId or proj_shortId), as returned by the projects API. Required for organization-scoped API keys; project-scoped keys may only pass their own project's short ID.

Pattern: ^proj(-.+_.+|_.+)$

Response

200 - application/json

The request has succeeded.

success
boolean
required
testPlan
object
required