Updates a test plan test case

PUT/testplantestcases/{id}

Test Plan Test Case to update

Example

Use resource IDs from your own project. Keep the API token in your server or CI environment.

TypeScript SDK

example.ts

import { createConfiguration, TestPlanTestCasesApi } from '@testcollab/sdk';

const config = createConfiguration(process.env.TESTCOLLAB_TOKEN!);
const api = new TestPlanTestCasesApi(config);

const result = await api.updateTestPlanTestCase({
  "id": 123,
  "testPlanTestCasePayload": {
    "testplan": 123
  }
});
console.log(result);

HTTP

curl --request PUT \
  "https://api.testcollab.io/testplantestcases/123?token=$TESTCOLLAB_TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{
  "testplan": 123,
  "testcase": 123,
  "project": 123,
  "assigned_to": 123,
  "status": "example",
  "config_assignees": []
}'

Parameters

Name	Location	Type	Required	Description
id	path	number	Yes	Test Plan Test Case ID

Request body

Field	Type	Required	Description
testplan	number	Yes	—
testcase	number	No	—
project	number	No	—
assigned_to	number	No	—
status	string	No	—
config_assignees	Config Wise Assignee Collection	No	—
config_assignees[].config_id	number	Yes	—
config_assignees[].assigned_to	number	No	Id of the assigned user

Response

200 — Updated Test Plan Test Case

Field	Type	Required	Description
id	number	Yes	—
test_case	Test Case Minified	Yes	—
test_case.id	number	Yes	—
test_case.display_number	number	No	Per-company sequential business id, surfaced in the UI as TC-
test_case.title	string	Yes	—
test_case.suite	number	No	—
test_case.description	string	Yes	Test case description (generated by rich text editor)
test_case.steps	Step Collection	No	—
test_case.steps[].step	string	Yes	(can contain HTML)
test_case.steps[].expected_result	string	Yes	(can contain HTML)
test_case.steps[].reusable_step_id	number	Yes	Reusable Step ID
test_case.steps_parsed	Step Parsed Collection	No	—
test_case.steps_parsed[].step	string	Yes	(can contain HTML)
test_case.steps_parsed[].step_id	number	No	—
test_case.steps_parsed[].expected_result	string	Yes	(can contain HTML)
test_case.steps_parsed[].step_index	number	No	—
test_case.steps_parsed[].parsed_reusable_step_id	number	No	—
test_case.priority	number	Yes	Priority, 0 - Low, 1- Normal, 2 - High Values: 0, 1, 2.
test_case.custom_fields	Array of Custom Field Collection Output	No	Array of custom fields
test_case.created_at	string	No	—
test_case.updated_at	string	No	—
test_case.created_by	number	No	—
test_case.last_run_status	string	No	—
test_case.run_count	number	No	—
test_case.avg_execution_time	number	No	—
test_case.last_run_on	string	No	—
test_case.failure_rate	number	No	Test failure percentage
test_case.is_bdd_managed	boolean	No	True when the test case is managed by BDD sync from a scenario in a feature file in Git.
test_case.is_reference	boolean	No	Will be true only for links
test_case.source_id	number	No	Only for links - source entity ID
test_case.source_project	number	No	Only for links - source Project ID
test_case.under_review	number	No	1 if test case is under review else 0 (applicable when test case review feature is enabled)
test_case.is_automated	number	No	Can be considered for execution by copilot (applicable when test case automation feature is enabled)
status	string	Yes	This is combined status for whole Test Case across multiple configurations (old values- 0, 1, 2, 3 ,4 and new values- unexecuted, passed, failed, skipped, blocked)
time_taken	number	Yes	Time taken (in seconds)
avg_time_per_exec	number	Yes	Time spent per execution
results	Config Wise Result Collection	No	—
results[].config_id	number	Yes	—
results[].status	string	Yes	This is combined status for whole Test Case across multiple configurations (old values- 0, 1, 2, 3 ,4 and new values- unexecuted, passed, failed, skipped, blocked)
config_assignees	Config Wise Assignee Collection	No	—
config_assignees[].config_id	number	Yes	—
config_assignees[].assigned_to	number	No	Id of the assigned user
last_run	string	No	Last run
assigned_to	User Minified	No	—
assigned_to.id	number	Yes	—
assigned_to.username	string	No	—
assigned_to.name	string	Yes	—
assigned_to.avatar	Upload	No	—
assigned_to.avatar.id	number	Yes	—
assigned_to.avatar.name	string	Yes	—
assigned_to.avatar.hash	string	Yes	—
assigned_to.avatar.ext	string	Yes	—
assigned_to.avatar.mime	string	Yes	—
assigned_to.avatar.size	string	Yes	—
assigned_to.avatar.url	string	Yes	—
assigned_to.avatar.created_by	number	No	—
assigned_to.avatar.created_at	string	Yes	—
assigned_to.avatar.updated_at	string	Yes	—
assigned_to.is_guest	number	No	—
created_at	string	Yes	—
updated_at	string	Yes	—

Illustrative response

{
  "id": 123,
  "test_case": {
    "id": 123,
    "display_number": 123,
    "title": "example",
    "suite": 123,
    "description": "example",
    "steps": [],
    "steps_parsed": [],
    "priority": 0,
    "custom_fields": []
  },
  "status": "example",
  "time_taken": 123,
  "avg_time_per_exec": 123,
  "results": [],
  "config_assignees": [],
  "last_run": "2026-10-19T09:00:00Z",
  "assigned_to": {
    "id": 123,
    "username": "example",
    "name": "example",
    "avatar": {
      "id": 123,
      "name": "example",
      "hash": "example",
      "ext": "example",
      "mime": "example",
      "size": "example",
      "url": "example",
      "created_by": 123,
      "created_at": "example"
    },
    "is_guest": 123
  }
}

Errors

Status	Meaning
403	Forbidden

Next steps

• Browse plans and runs
• Authentication
• Handle errors