create_test_plan
Create a Zephyr Scale test plan by specifying name, owner, folder, and status. The folder must already exist; returns the plan key.
Instructions
Create a test plan (POST /testplan). folder must be a TEST_PLAN folder (create_folder with type TEST_PLAN) — The folder MUST already exist — the API never creates folders implicitly (use create_folder first). status is a case-sensitive internal name. owner: Jira user key (e.g. 'JIRAUSER10000'), NOT a username or e-mail — resolve it with find_jira_user. Returns { key } (e.g. "PROJ-P123") — no UI url, because the test plan page has no stable address across Zephyr Scale versions.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Test plan name | |
| owner | No | Owner. Jira *user key* (e.g. 'JIRAUSER10000'), NOT a username or e-mail — resolve it with find_jira_user. | |
| folder | No | Full path of a TEST_PLAN folder from the root starting with "/", e.g. "/Releases/2026". The folder MUST already exist — the API never creates folders implicitly (use create_folder first). | |
| labels | No | Labels; the API replaces spaces with underscores | |
| status | No | Test plan status. Defaults: 'Draft', 'Approved', 'Deprecated' — case-sensitive; instances may define custom ones. Plan statuses are their OWN option set: get_status_options cannot list them (it has no test_plan optionSet) and the test CASE statuses it returns are rejected here with 400 "The value <x> was not found for field status." | |
| objective | No | Objective (HTML allowed) | |
| issueLinks | No | Jira issue keys to link, e.g. ["PROJ-123"] | |
| projectKey | No | Jira project key, e.g. "PROJ"; defaults to ZEPHYR_DEFAULT_PROJECT_KEY when omitted | |
| customFields | No | Custom field values keyed by field name |