Update a test plan

PUT/projects/{project_id}/test_plans/{test_plan_id}

Base URL https://arcus.testsigma.com/api/v1

Updates an existing test plan within a specific project.

Authenticate with your API key as a Bearer token in the Authorization header. How to authenticate →

Path parameters

`project_id`	Unique identifier of the project that contains the test plan.
`test_plan_id`	Unique identifier of the test plan to update.

Request body

title Updated title of the test plan.

Response attributes

`message`	Status message for the request; may be empty.
`data.test_plan.id`	Unique identifier of the test plan.
`data.test_plan.human_id`	Human-readable identifier of the test plan.
`data.test_plan.title`	Updated title of the test plan.
`data.test_plan.description`	Description of the test plan.
`data.test_plan.status`	Current status of the test plan.
`data.test_plan.updated_at`	Unix timestamp of the last update to the test plan.

Request

curl -X PUT \
  'https://arcus.testsigma.com/api/v1/projects/{project_id}/test_plans/{test_plan_id}' \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Patient Portal Regression - Updated"
  }'

const response = await fetch('https://arcus.testsigma.com/api/v1/projects/{project_id}/test_plans/{test_plan_id}', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer <API_KEY>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
      "title": "Patient Portal Regression - Updated"
  })
});
const data = await response.json();

import requests

response = requests.put(
  'https://arcus.testsigma.com/api/v1/projects/{project_id}/test_plans/{test_plan_id}',
  headers={
    'Authorization': 'Bearer <API_KEY>',
    'Content-Type': 'application/json'
  },
  json={
      "title": "Patient Portal Regression - Updated"
  }
)
data = response.json()

Response200 OK

{
  "message": "",
  "data": {
    "test_plan": {
      "id": "f2a8c1d4-9e63-4b27-8a51-7c0d6e9f3b42",
      "human_id": "HCP-P-2",
      "title": "Patient Portal Regression - Updated",
      "description": "Full regression cycle for the Q2 patient portal release.",
      "status": "ACTIVE",
      "updated_at": 1710803200
    }
  }
}

Was this page helpful?