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

Complete a test plan

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

Marks a specific test plan as complete within a project.

Authenticate with your API key as a Bearer token in the Authorization header. How to authenticate →
project_idUnique identifier of the project that contains the test plan.
test_plan_idUnique identifier or human-readable ID of the test plan to mark as complete.
messageStatus message for the request.
data.test_planThe completed test plan, with the same fields as Get a test plan.
data.test_plan.statusCOMPLETED.
data.test_plan.completed_atUnix timestamp, in milliseconds, of when the test plan was marked complete.
data.test_plan.completed_byID of the user who completed the test plan. For a request made with an API key, this is the key's user.
Request
curl -X POST \
  'https://arcus.testsigma.com/api/v1/projects/{project_id}/test_plans/{test_plan_id}/complete' \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: application/json'
const response = await fetch('https://arcus.testsigma.com/api/v1/projects/{project_id}/test_plans/{test_plan_id}/complete', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <API_KEY>',
    'Content-Type': 'application/json'
  }
});
const data = await response.json();
import requests

response = requests.post(
  'https://arcus.testsigma.com/api/v1/projects/{project_id}/test_plans/{test_plan_id}/complete',
  headers={
    'Authorization': 'Bearer <API_KEY>',
    'Content-Type': 'application/json'
  }
)
data = response.json()
Response200 OK
{
  "message": "Test plan completed 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": "COMPLETED",
      "start_date": 1710374400000,
      "end_date": 1712966400000,
      "completed_at": 1712966400000,
      "completed_by": "a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
      "project_id": "bd57bbc6-e83e-4f09-927d-fc48b3509cdf",
      "environment_id": null,
      "test_runs_count": 1,
      "test_cases_count": 42,
      "created_at": 1710370000000,
      "updated_at": 1712966400000
    }
  }
}

Was this page helpful?