Skip to content
Testsigma DOCS
Login Book a demo

Update a test run

PUT/projects/:project_id/test_runs/:test_run_id

Base URL  https://test-management.testsigma.com/api/v1

Updates the attributes of an existing test run, such as its title, status, and schedule.

Authenticate with your API key as a Bearer token in the Authorization header. Generate a key →

PATH PARAMETERS

project_idUnique identifier of the project the test run belongs to.
test_run_idIdentifier of the test run to update.

REQUEST BODY

titleTitle of the test run.
descriptionDetailed description of the test run.
statusCurrent status of the test run (e.g. ACTIVE).
project_idUnique identifier of the project the test run belongs to.
human_idHuman-readable identifier for the test run.
selection_typeType of test case selection for the run (e.g. STATIC).
start_dateStart date of the test run as a Unix timestamp.
end_dateEnd date of the test run as a Unix timestamp.
assignee_idUnique identifier of the user assigned to the test run.
label_namesArray of labels associated with the test run.
environment_idsArray of environment identifiers the test run executes against.

RESPONSE ATTRIBUTES

messageStatus message for the request; may be empty.
data.test_run.idUnique identifier of the test run.
data.test_run.titleUpdated title of the test run.
data.test_run.descriptionUpdated description of the test run.
data.test_run.statusUpdated status of the test run.
data.test_run.project_idUnique identifier of the project the test run belongs to.
data.test_run.human_idUpdated human-readable identifier for the test run.
data.test_run.selection_typeType of test case selection for the run.
data.test_run.start_dateUpdated start date as a Unix timestamp.
data.test_run.end_dateUpdated end date as a Unix timestamp.
data.test_run.assignee_idUnique identifier of the user assigned to the test run.
data.test_run.label_namesUpdated labels associated with the test run.
data.test_run.environment_idsUpdated environment identifiers the test run executes against.
REQUEST
curl -X PUT \
  'https://test-management.testsigma.com/api/v1/projects/:project_id/test_runs/:test_run_id' \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Regression suite — patient portal (updated)",
    "description": "Executing regression test cases",
    "status": "ACTIVE",
    "project_id": "c47ade67-0543-4582-a4a5-b7de447c94f5",
    "human_id": "DEMO-001",
    "selection_type": "STATIC",
    "start_date": 1710675200,
    "end_date": 1710761600,
    "assignee_id": "cbbc40a5-26e9-4b88-8c27-3626c9fbdaa4",
    "label_names": [
      "Smoke",
      "Regression"
    ],
    "environment_ids": []
  }'
const response = await fetch('https://test-management.testsigma.com/api/v1/projects/:project_id/test_runs/:test_run_id', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer <API_KEY>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
      "title": "Regression suite — patient portal (updated)",
      "description": "Executing regression test cases",
      "status": "ACTIVE",
      "project_id": "c47ade67-0543-4582-a4a5-b7de447c94f5",
      "human_id": "DEMO-001",
      "selection_type": "STATIC",
      "start_date": 1710675200,
      "end_date": 1710761600,
      "assignee_id": "cbbc40a5-26e9-4b88-8c27-3626c9fbdaa4",
      "label_names": [
          "Smoke",
          "Regression"
      ],
      "environment_ids": []
  })
});
const data = await response.json();
import requests

response = requests.put(
  'https://test-management.testsigma.com/api/v1/projects/:project_id/test_runs/:test_run_id',
  headers={
    'Authorization': 'Bearer <API_KEY>',
    'Content-Type': 'application/json'
  },
  json={
      "title": "Regression suite — patient portal (updated)",
      "description": "Executing regression test cases",
      "status": "ACTIVE",
      "project_id": "c47ade67-0543-4582-a4a5-b7de447c94f5",
      "human_id": "DEMO-001",
      "selection_type": "STATIC",
      "start_date": 1710675200,
      "end_date": 1710761600,
      "assignee_id": "cbbc40a5-26e9-4b88-8c27-3626c9fbdaa4",
      "label_names": [
          "Smoke",
          "Regression"
      ],
      "environment_ids": []
  }
)
data = response.json()
RESPONSE200OK
{
  "message": "",
  "data": {
    "test_run": {
      "id": "7b2f9c14-58a1-4d2e-9f3a-6c1e8d40a2b9",
      "title": "Regression suite — patient portal (updated)",
      "description": "Executing regression test cases",
      "status": "ACTIVE",
      "project_id": "c47ade67-0543-4582-a4a5-b7de447c94f5",
      "human_id": "DEMO-001",
      "selection_type": "STATIC",
      "start_date": 1710675200,
      "end_date": 1710761600,
      "assignee_id": "cbbc40a5-26e9-4b88-8c27-3626c9fbdaa4",
      "label_names": [
        "Smoke",
        "Regression"
      ],
      "environment_ids": []
    }
  }
}