Skip to content

Update a test case

PATCH
/v1/test-cases/{id}
curl --request PATCH \
--url https://beta-api.plune.ai/v1/test-cases/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "priority": "critical", "tags": [ "smoke", "checkout", "regression" ], "precondition": "A signed-in customer with an empty cart." }'

The case form on save, “Move to…” and the lifecycle buttons (api.ts → updateTestCase): any subset of the writable fields, merged and re-validated whole. state moves the case through its lifecycle and is refused with the allowed moves when the matrix does not permit it for this caller — a token cannot retire a case, a person can. stateReason is kept on the audit entry, so the “why” survives the move.

id
required
string format: uuid
Media type application/json

Any subset of the writable fields. The merged record is re-validated against the contract, so a patch that would leave the case invalid is rejected with 400.

object
title
string
state

The case’s place in its lifecycle. in_review is a case a proposal produced and nobody has confirmed yet; detached is one whose source stopped being reported. Who may move it where depends on whether the caller is a session or a token.

string
Allowed values: draft in_review active detached deprecated
status

Derived from state for clients on v1, never stored. in_review answers as draft and detached as active — v1 has no word for either.

string
Allowed values: draft active archived
stateReason

Why the case last moved.

string
stateChangedAt

When it last moved. Absent on a case that has not moved.

string format: date-time
suiteId

Three states: omit to keep the current suite, a suite id to re-file the case, or null to take it out of its suite.

string
nullable
evalId

Same three states: omit to keep, an eval id to link future runs to this case, null to unlink. Past results stay attached — they are already recorded.

string
nullable
priority
string
Allowed values: low normal important high critical
estimate
One of:
string
tags

[] strips every tag from the title; a list rewrites its tail. When both title and tags are sent, tags wins over the title’s tail (AC-08).

Array<string>
description

null clears it.

string
nullable
precondition

null clears it.

string
nullable
examples

null clears the table; a missing key keeps it.

object
params
required
Array<string>
>= 1 items <= 16 items
rows
required
Array<Array<string>>
>= 1 items <= 100 items
assigneeId

Who is to run it (B8-team T4): a member of this project — anyone else is refused (400 user … is not a member of this project); null takes the case back; omit to keep. Metadata: the version does not move.

string
nullable
isFlaky

Set or clear the flaky flag (#1246); omit to keep. null is refused — a flag is set or it is not. Metadata: the version does not move.

boolean
isMuted

Mute or unmute the case (#1246); omit to keep. Same rules as isFlaky; each change is an audit entry with who and when — a person, or the token that sent it.

boolean
custom

Custom field values to change (#1250): a key sets it, null (or [] on a multiple list) clears it, a key left out keeps its value. A required field’s value cannot be cleared, but an old case is not made to fill one in.

object
is_flaky

isFlaky as @plune-ai/cli 0.17.1 spells it. isFlaky wins when both are sent; null is refused the same way.

boolean
is_muted

isMuted as the runner spells it. isMuted wins when both are sent.

boolean
position

The new slot among the siblings; the others close ranks. A move to another suite without it lands last.

integer
steps
Array<object>
object
action
required
string
expected
required
string
specRef
string
prompt
string
goldenSetId
string
assertions
Array<object>

One assertion: a type plus whatever that type needs (ADR 0012). The remaining fields depend on type (e.g. values for contains-all, criteria for llm-judge).

object
type
required
string
key
additional properties
any
Examples

Rank, tags and a precondition

{
"priority": "critical",
"tags": [
"smoke",
"checkout",
"regression"
],
"precondition": "A signed-in customer with an empty cart."
}

Updated

Media type application/json
One of:

A stored test case — the metadata plus the body of its type.

object
schemaVersion
required

Accepted: 1 or 2. Responses are always 2 — a v1 record is upgraded on read.

integer
Allowed values: 1 2
id
required
string format: uuid
projectId
required
string
title
required

Carries its @tag tail — the one source of tags (ADR 0032). The dashboard shows the clean title and the tags as chips.

string
state
required

The case’s place in its lifecycle. in_review is a case a proposal produced and nobody has confirmed yet; detached is one whose source stopped being reported. Who may move it where depends on whether the caller is a session or a token.

string
Allowed values: draft in_review active detached deprecated
status
required

Derived from state for clients on v1, never stored. in_review answers as draft and detached as active — v1 has no word for either.

string
Allowed values: draft active archived
stateReason

Why the case last moved.

string
defects

Only when reading ONE case (#1064): its defect links, oldest first, at most 20; [] for a case without any. The list carries a count per case instead (defectCounts).

Array<object>

A defect (#1064): the address of a ticket somebody already filed, kept beside a case or a failed result. https only, at most 2000 characters; the label is plain text, at most 200, and is shown as text, never as markup. The author is a userId; the dashboard names them from GET /v1/members. No type: Bugs (#1065) will read the same links as external tickets.

object
id
required
string format: uuid
url
required
string
<= 2000 characters /^[Hh][Tt][Tt][Pp][Ss]:///
label
required
string
nullable <= 200 characters
authorId
required
string
createdAt
required
string format: date-time
allowedStates

Only when reading ONE case: the states the caller may move it to from here, per the lifecycle table and who the caller is - a session is a person, a bearer token is automation. A screen renders exactly these as actions and never lists moves itself. The current state is not included.

Array<string>
Allowed values: draft in_review active detached deprecated
stateChangedAt

When it last moved. Absent on a case that has not moved.

string format: date-time
suiteId

The suite this case is filed under, if any. Always a suite, never a folder (AC-03).

string
priority
required

Five levels in rank order — low < normal < important < high < critical. Metadata: changing it does not bump the text version.

string
Allowed values: low normal important high critical
estimate

The time the case takes by hand (#1881), as 1h 30m, 5m or 45s — the spelling a write takes back. Absent while nobody estimated it (stored as NULL, which is not 0). Metadata: changing it does not bump the text version.

string
estimateSeconds

estimate in whole seconds, for a report that adds them up. Absent with estimate; send estimate to change it.

integer
<= 3600000
position
required

Order among the cases of its suite (or the unfiled ones) — dense, 0-based, renumbered on every write that places a case (AC-05).

integer
isFlaky
required

An assertion about the case (#1246): this test is unstable by nature. Diagnostics — a person or a machine may set it. Always present, false until set. Metadata: changing it does not bump the text version. ?flaky=1 (or 0) on the list filters on it.

boolean
custom

Field id → value, as stored on the entity. A string field takes text (1–1 000 characters), a number field a number, a list field the id of one option — or, when multiple, an array of option ids without repeats (up to 50), kept in the order written. At most 16 384 bytes of JSON.

object
key
additional properties
One of:
string
isMuted
required

A person’s decision about the case (#1246): it still runs and its results are recorded, and a failure is not to count toward the run (#1247). Not the same as isFlaky — a flaky case need not be muted, and a muted one need not be flaky. Always present, false until set; a parameterized case is one case, so muting it mutes every row of its parameters. A mute may come from a token; the audit names who — a person, or the token (a runner’s is_muted is an annotation in the code, written and reviewed like test.skip). Every set and clear is an entry in the case’s audit feed. ?muted=1 (or 0) on the list filters on it.

boolean
tags
required

Read from the title by the server, each once, in first-seen order. Derived: sent back, never taken on the way in as a field of its own — tags on a write rewrites the title.

Array<string>
description

Free text beside the steps. Part of what a result was produced against, so a change bumps the text version (AC-09). Absent when never set. 16 384 bytes of UTF-8 at most.

string
precondition

What must hold before the steps. Same rules as description.

string
examples

The parameters table (D7). Content like the two texts: a change bumps the version.

object
params
required
Array<string>
>= 1 items <= 16 items
rows
required
Array<Array<string>>
>= 1 items <= 100 items
externalKeys

The identifiers this case has elsewhere (D2) — attached on every read; absent when it has none.

Array<object>
<= 32 items

An identifier another tool already uses for this test, so a report can find its case without anyone typing a Plune id. The order of kind is load-bearing: it is the ranking that decides which key wins when several match different cases.

object
kind
required
string
Allowed values: playwright-id path-title allure-history cairn-stable eval-id qase testrail testomat zephyr
value
required
string
<= 1024 characters
evalId

The id of this case’s eval in plune.yaml. An ingested run attaches its results to the case carrying the same id (ADR 0010); absent for cases the CLI does not run.

string
codeSnapshot

Only when reading ONE case: the source text of the one test() call an automated case references — the call itself, header and body, exactly as written in the file. Absent on a case that has never had one; present-and-unchanged when the file most recently failed to parse (the last known snapshot, not empty). 16 384 bytes of UTF-8 at most, the same ceiling description/precondition already carry.

string
codeSnapshotHash

SHA-256 hex digest of codeSnapshot, recomputed by the server on every write that touches it (ADR-0005) — never accepted from a client. Present whenever codeSnapshot is, and on the list too even though the text itself is not: a re-importer hashes its own freshly parsed text the same way and compares against this to decide changed vs unchanged without a second request per case.

string
createdBy

Who wrote it (B8-team T3): the userId of the caller of POST /v1/test-cases or of a duplicate. Set by the server, never taken from a body, never changed by a PATCH. Absent on a case from before names were kept and on one the review queue created. Resolve it through GET /v1/members.

string
assigneeId

Who is to run it (B8-team T4): the userId of a member of the project. Set by PATCH {assigneeId} or the bulk assign action, never on create; null on a PATCH takes it away; leaving the project takes it away too. Absent means unassigned. GET /v1/test-cases?assignee=me|none|<userId> filters on it.

string
origin

Where the text of the case came from (#1879), derived on read - no column, so every case has one, the ones from before included. manual: a person wrote it. ai-generated: created from an approved proposal in the review queue, or a field accepted from an AI draft, and not corrected since. ai-edited: a person corrected AI-written content - the reviewer before approving, or anyone after (the version moved), or the text of an accepted draft. Read-only; on the list and on the single read. GET /v1/test-cases?origin= filters on it.

string
Allowed values: manual ai-generated ai-edited
originDetail

The facts behind origin, on the single read only (#1879) - for a tooltip. Only what is already stored; ids of people, never addresses.

object
proposedBy

The userId that put the proposal in the review queue.

string
source

What the supplier said the proposal was derived from.

object
kind
required
string
Allowed values: url openapi-operation requirement pasted-text
value
required
string
>= 1 characters <= 100 characters
editedFields
required

Fields a person changed on AI text: title, steps, expected (the reviewer, #1878), description, precondition (after an accepted draft).

Array<string>
editedAfterCreation
required

A case made from a proposal whose content (title, texts, steps, parameters) has changed since.

boolean
approvedBy

The userId of the latest approval of the standing revision; absent when the policy merged it by itself.

string
approvedAt
string format: date-time
provenance

Where the case came from, present only on one an approved proposal created (B-1). Read through that proposal rather than stored on the case, so it answers for every case ever created this way and can never disagree with the queue entry beside it. Absent on a case a person wrote — and absent, too, when the proposal named neither field: both mean nothing was reported.

object
source
object
kind
required
string
Allowed values: url openapi-operation requirement pasted-text
value
required
string
>= 1 characters <= 100 characters
technique

The test-design technique the supplier named, as they named it.

string
<= 32 characters
textOrigin

Where a field’s text came from, once it was accepted from an AI draft (automated-case-description-draft, AC-17): per field, the model, the date of the draft, who asked, who accepted and when, and — if a person edited the text afterwards — who and when. A field has an entry only while its text is the one a draft produced: the next accepted draft replaces it and clearing the field drops it. The key is absent when no field was ever accepted from a draft. Written only by the case store’s single write path — never taken from a client body, on a PATCH or on Markdown import alike.

object
description

One field’s provenance (AC-17). The same facts the dashboard shows under the field; the hash the server compares the code against is never part of it.

object
model
required

The model that drafted this text, as recorded on the call at the time — not the project’s current model: a later change must not relabel old text.

string
provider

#829: the provider that made the draft, as recorded on the call. Absent on text accepted before the fallback existed.

string
Allowed values: anthropic openrouter custom
viaFallback

#829: true when the fallback provider made the draft. Absent (not false) on text accepted before the fallback existed.

boolean
draftedAt
required

When the draft that produced this text was requested — “the date of the draft”.

string format: date-time
requestedBy
required

userId of the member who asked for the draft — resolve through GET /v1/members like TestCaseMeta.createdBy.

string
acceptedBy
required

userId of the member who accepted it into the case.

string
acceptedAt
required
string format: date-time
editedBy

Present when a person edited this field after accepting it (AC-17); absent otherwise.

string
editedAt

When editedBy last edited it. Present exactly when editedBy is.

string format: date-time
codeChangedSinceAccepted
required

Whether the case’s code snapshot changed, beyond whitespace, since this text was drafted (AC-16, AC-04b) — read again every time the case is read, not frozen when the text was accepted.

boolean
precondition

One field’s provenance (AC-17). The same facts the dashboard shows under the field; the hash the server compares the code against is never part of it.

object
model
required

The model that drafted this text, as recorded on the call at the time — not the project’s current model: a later change must not relabel old text.

string
provider

#829: the provider that made the draft, as recorded on the call. Absent on text accepted before the fallback existed.

string
Allowed values: anthropic openrouter custom
viaFallback

#829: true when the fallback provider made the draft. Absent (not false) on text accepted before the fallback existed.

boolean
draftedAt
required

When the draft that produced this text was requested — “the date of the draft”.

string format: date-time
requestedBy
required

userId of the member who asked for the draft — resolve through GET /v1/members like TestCaseMeta.createdBy.

string
acceptedBy
required

userId of the member who accepted it into the case.

string
acceptedAt
required
string format: date-time
editedBy

Present when a person edited this field after accepting it (AC-17); absent otherwise.

string
editedAt

When editedBy last edited it. Present exactly when editedBy is.

string format: date-time
codeChangedSinceAccepted
required

Whether the case’s code snapshot changed, beyond whitespace, since this text was drafted (AC-16, AC-04b) — read again every time the case is read, not frozen when the text was accepted.

boolean
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
type
required
string
Allowed values: manual
steps
required
Array<object>
object
action
required
string
expected
required
string
Example
{
"schemaVersion": 2,
"id": "6f1c2b3a-0000-4000-8000-0000000000c1",
"type": "automated",
"specRef": "e2e/checkout.spec.ts#empty-cart",
"projectId": "u-shop::default",
"title": "Checkout — empty cart @smoke @checkout @regression",
"state": "draft",
"suiteId": "6f1c2b3a-0000-4000-8000-0000000000a1",
"description": "An empty cart must not reach the payment step.",
"priority": "critical",
"position": 0,
"isFlaky": false,
"isMuted": false,
"createdBy": "u-shop",
"createdAt": "2026-09-16T09:12:04.151Z",
"updatedAt": "2026-09-16T09:12:04.151Z",
"externalKeys": [
{
"kind": "path-title",
"value": "e2e/checkout.spec.ts > Checkout — empty cart"
}
],
"status": "draft",
"tags": [
"smoke",
"checkout",
"regression"
],
"precondition": "A signed-in customer with an empty cart."
}

The merged record is invalid, the suite is missing / not yours / a folder, a title of tags only, an invalid tag or an unknown priority — the same words as on create

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}

No / invalid token or session

Not found or not yours

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}

A key in externalKeys already belongs to another case — the body then also carries kind, value and ownerCaseId, and nothing was written; OR the case was saved by someone else again and again while this save was being made, and the case itself was not saved (the keys the request named, if it named any, are already saved) — read it again and retry. One save in that window is not a refusal: the case is read again and the change is made on top of it. In a bulk call the same refusal is an entry in refused.

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}

Rate-limited: the per-route throttle, or the per-minute request limit of the plan an API token counts by (#1442; the body names the plan, #2092). Retry-After carries the seconds until the window rolls over.

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}
Retry-After
integer

Seconds until the window rolls over