Complete a test plan

POST/projects/:project_id/test_plans/:test_plan_id/complete

Base URL https://test-management.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. Generate a key →

PATH PARAMETERS

`project_id`	Unique identifier of the project that contains the test plan.
`test_plan_id`	Unique identifier of the test plan to mark as complete.

RESPONSE ATTRIBUTES

`status`	Indicates whether the operation succeeded or failed.
`message`	Descriptive message providing context about the outcome.
`data.test_plan.id`	Unique identifier of the completed test plan.
`data.test_plan.status`	Status of the test plan after completion.
`data.test_plan.completed_at`	Unix timestamp of when the test plan was marked complete.

REQUEST

curl -X POST \
  'https://test-management.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://test-management.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://test-management.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()

RESPONSE200OK

{
  "status": "success",
  "message": "Test plan marked as complete.",
  "data": {
    "test_plan": {
      "id": "f2a8c1d4-9e63-4b27-8a51-7c0d6e9f3b42",
      "status": "COMPLETED",
      "completed_at": 1712966400
    }
  }
}