Mark a requirement ready despite failures
const url = 'https://beta-api.plune.ai/v1/requirements/example/health-mark';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"reason":"The three failures come from the payment sandbox, not the coupon code."}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://beta-api.plune.ai/v1/requirements/example/health-mark \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "reason": "The three failures come from the payment sandbox, not the coupon code." }'The project owner’s (#2011; a member or a reader gets 403). Health reads ready until a run changes the result of one of the linked cases from what it was at this moment: a run that gives the same results keeps the mark, and so does a late result of an older run. Refused (409) when every linked case passed already, when no case is linked, when it is marked already, and on an archived requirement. An entry of Settings → Activity: the owner, health from what to ready, and whether a reason was given (a digest, not the text).
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”The requirement’s id, or its key (REQ-214, any case).
Request Body required
Section titled “Request Body required ”object
Optional; trimmed, and empty is none.
Example
{ "reason": "The three failures come from the payment sandbox, not the coupon code."}Responses
Section titled “ Responses ”The requirement with its mark
object
The requirement’s short name (REQ-214), unique in the project, case-insensitive. Generated (REQ-<n>, per project, a number is never reused) or supplied. Never only digits, never an id.
Where the requirement stands. Archiving is separate (archivedAt) and keeps the status.
Plain text, at most 16384 bytes.
A free short label (Must-have, High), not an enum. null - not set.
Markdown text. null - not set.
Which kind of requirement it is. null - not set.
How the linked cases stand, counted from their RESULTS, never from a flag: each live case once, under the status of its newest result in a run that is not in the Bin (newest by when the run was created) — the status the run counters count it under, so a muted case’s failure is muted. A case with no result is notRun; a case in the Bin is not counted. total is the sum of the rest; «N of M cases passed» is passed of total.
object
M — the live cases linked to the requirement.
N — the cases whose newest result is passed.
Muted cases whose newest result failed or broke.
Cases with no result in a run that is not in the Bin.
Of total, the cases of kind automated — the numerator of «9 of 14 cases are automated»; the denominator is total.
Only in the list asked with ?cases=true; always in the one requirement’s page.
object
The status the coverage counted the case under; null — no result yet.
The run that result is in; null — no result yet.
#2461: the MCP tools the case tests (PUT /v1/mcp-tools/{id}/cases), so a requirement reaches its tools through its cases. Absent in a matrix version saved before 0.1.89: a saved version is kept as it was.
object
#2252: on every row of the list and on the one requirement’s page, not in the answer of a write nor in a matrix snapshot. null — health follows the results.
object
object
The id of the owner who set it.
null — none was given.
How the linked cases stand, counted from their RESULTS, never from a flag: each live case once, under the status of its newest result in a run that is not in the Bin (newest by when the run was created) — the status the run counters count it under, so a muted case’s failure is muted. A case with no result is notRun; a case in the Bin is not counted. total is the sum of the rest; «N of M cases passed» is passed of total.
object
M — the live cases linked to the requirement.
N — the cases whose newest result is passed.
Muted cases whose newest result failed or broke.
Cases with no result in a run that is not in the Bin.
Of total, the cases of kind automated — the numerator of «9 of 14 cases are automated»; the denominator is total.
object
The run whose results took the mark off.
Its title then; null — it had none.
How the linked cases stand, counted from their RESULTS, never from a flag: each live case once, under the status of its newest result in a run that is not in the Bin (newest by when the run was created) — the status the run counters count it under, so a muted case’s failure is muted. A case with no result is notRun; a case in the Bin is not counted. total is the sum of the rest; «N of M cases passed» is passed of total.
object
M — the live cases linked to the requirement.
N — the cases whose newest result is passed.
Muted cases whose newest result failed or broke.
Cases with no result in a run that is not in the Bin.
Of total, the cases of kind automated — the numerator of «9 of 14 cases are automated»; the denominator is total.
Set while the requirement is archived: out of the default list and out of every coverage filter; its links stay.
The live cases linked to it, by title. A case in the Bin is not here until it is brought back.
object
The status the coverage counted the case under; null — no result yet.
The run that result is in; null — no result yet.
#2461: the MCP tools the case tests (PUT /v1/mcp-tools/{id}/cases), so a requirement reaches its tools through its cases. Absent in a matrix version saved before 0.1.89: a saved version is kept as it was.
object
#2011: the owner’s «ready despite failures», or the record that a run took it off. null — health follows the results.
object
object
The id of the owner who set it.
null — none was given.
How the linked cases stand, counted from their RESULTS, never from a flag: each live case once, under the status of its newest result in a run that is not in the Bin (newest by when the run was created) — the status the run counters count it under, so a muted case’s failure is muted. A case with no result is notRun; a case in the Bin is not counted. total is the sum of the rest; «N of M cases passed» is passed of total.
object
M — the live cases linked to the requirement.
N — the cases whose newest result is passed.
Muted cases whose newest result failed or broke.
Cases with no result in a run that is not in the Bin.
Of total, the cases of kind automated — the numerator of «9 of 14 cases are automated»; the denominator is total.
object
The run whose results took the mark off.
Its title then; null — it had none.
How the linked cases stand, counted from their RESULTS, never from a flag: each live case once, under the status of its newest result in a run that is not in the Bin (newest by when the run was created) — the status the run counters count it under, so a muted case’s failure is muted. A case with no result is notRun; a case in the Bin is not counted. total is the sum of the rest; «N of M cases passed» is passed of total.
object
M — the live cases linked to the requirement.
N — the cases whose newest result is passed.
Muted cases whose newest result failed or broke.
Cases with no result in a run that is not in the Bin.
Of total, the cases of kind automated — the numerator of «9 of 14 cases are automated»; the denominator is total.
Example
{ "id": "6f1c2b3a-0000-4000-8000-0000000000f5", "key": "REQ-214", "projectId": "u-shop::default", "type": "user_story", "status": "active", "title": "A buyer pays by card", "description": "As a buyer I pay for the order by card, so that I do not wait for an invoice.", "priority": "Must-have", "acceptanceCriteria": "- the card is charged once\n- a declined card shows the bank reason", "category": "functional", "coverage": { "total": 3, "passed": 2, "failed": 1, "broken": 0, "blocked": 0, "skipped": 0, "muted": 0, "notRun": 0, "automated": 0 }, "archivedAt": null, "createdAt": "2026-09-16T09:12:04.151Z", "updatedAt": "2026-09-16T09:12:04.151Z", "cases": [], "healthMark": { "state": "set", "by": "u-shop", "at": "2026-09-16T09:12:04.151Z", "reason": "The three failures come from the payment sandbox, not the coupon code.", "was": { "total": 3, "passed": 2, "failed": 1, "broken": 0, "blocked": 0, "skipped": 0, "muted": 0, "notRun": 0, "automated": 0 } }}Invalid body, or a reason over 500 characters
object
Example generated
{ "error": "example"}No / invalid token or session
You are not the project’s owner (owner_only)
object
Example generated
{ "error": "example"}No such requirement in your projects
object
Example generated
{ "error": "example"}passing - every linked case passed; no_cases; marked - set already; archived
object
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.
object
Example generated
{ "error": "example"}Headers
Section titled “Headers ”Seconds until the window rolls over