Skip to content
Docs
Arcus
Popular questions
↑↓ to navigate↵ to selectesc to close
Book a demo

Create a test plan

POST/projects/{project_id}/test_plans
Base URL https://arcus.testsigma.com/api/v1

Creates a new test plan within a specific project.

Authenticate with your API key as a Bearer token in the Authorization header. How to authenticate →
project_idUnique identifier of the project to create the test plan in.
titleTitle of the test plan.
descriptionDetailed description of the test plan.
start_dateStart date of the test plan as a Unix timestamp. A value in seconds is converted to milliseconds.
end_dateEnd date of the test plan as a Unix timestamp. A value in seconds is converted to milliseconds. Must not be before start_date.
label_idsLabel names to add to the test plan. A name that does not exist yet creates the label. The field takes names, despite its name.
environment_idUnique identifier of the environment the plan's runs use. It must belong to the project. Without it, the project default is used.
messageStatus message for the request.
data.test_plan.idUnique identifier of the test plan.
data.test_plan.human_idHuman-readable identifier of the test plan.
data.test_plan.titleTitle of the test plan.
data.test_plan.descriptionDescription of the test plan. Left out when empty.
data.test_plan.statusACTIVE or COMPLETED.
data.test_plan.start_dateStart date of the test plan as a Unix timestamp in milliseconds. 0 when not set.
data.test_plan.end_dateEnd date of the test plan as a Unix timestamp in milliseconds. 0 when not set.
data.test_plan.completed_atUnix timestamp, in milliseconds, of when the test plan was completed. Left out until then.
data.test_plan.completed_byID of the user who completed the test plan. Left out until then.
data.test_plan.project_idUnique identifier of the project.
data.test_plan.labelsLabels on the test plan, each with id, name, createdAt, and updatedAt. Left out when there are none.
data.test_plan.environment_idEnvironment the plan's runs use. Null means the project default.
data.test_plan.test_runs_countNumber of test runs in the test plan.
data.test_plan.test_cases_countNumber of test cases in the test plan.
data.test_plan.created_atUnix timestamp, in milliseconds, of when the test plan was created.
data.test_plan.updated_atUnix timestamp, in milliseconds, of the last update to the test plan.
Request
curl -X POST \
  'https://arcus.testsigma.com/api/v1/projects/{project_id}/test_plans' \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Patient Portal Regression",
    "description": "Full regression cycle for the Q2 patient portal release.",
    "start_date": 1710374400000,
    "end_date": 1712966400000,
    "label_ids": [
      "regression"
    ]
  }'
const response = await fetch('https://arcus.testsigma.com/api/v1/projects/{project_id}/test_plans', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <API_KEY>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
      "title": "Patient Portal Regression",
      "description": "Full regression cycle for the Q2 patient portal release.",
      "start_date": 1710374400000,
      "end_date": 1712966400000,
      "label_ids": [
          "regression"
      ]
  })
});
const data = await response.json();
import requests

response = requests.post(
  'https://arcus.testsigma.com/api/v1/projects/{project_id}/test_plans',
  headers={
    'Authorization': 'Bearer <API_KEY>',
    'Content-Type': 'application/json'
  },
  json={
      "title": "Patient Portal Regression",
      "description": "Full regression cycle for the Q2 patient portal release.",
      "start_date": 1710374400000,
      "end_date": 1712966400000,
      "label_ids": [
          "regression"
      ]
  }
)
data = response.json()
Response201 Created
{
  "message": "Test plan created successfully",
  "data": {
    "test_plan": {
      "id": "f2a8c1d4-9e63-4b27-8a51-7c0d6e9f3b42",
      "human_id": "HCP-P-1",
      "title": "Patient Portal Regression",
      "description": "Full regression cycle for the Q2 patient portal release.",
      "status": "ACTIVE",
      "start_date": 1710374400000,
      "end_date": 1712966400000,
      "project_id": "bd57bbc6-e83e-4f09-927d-fc48b3509cdf",
      "labels": [
        {
          "id": "3ebf1ec4-f994-4f41-822a-01305e1f78c1",
          "name": "regression",
          "createdAt": 1710370000000,
          "updatedAt": 1710370000000
        }
      ],
      "environment_id": null,
      "test_runs_count": 0,
      "test_cases_count": 0,
      "created_at": 1710370000000,
      "updated_at": 1710370000000
    }
  }
}

Was this page helpful?