Update a scheduled test plan

PUT/schedule_executions/{scheduleId}

Base URL https://app.testsigma.com/api/v1Region

Update an existing test plan schedule using the REST API.

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

Path parameters

scheduleId The ID of the required schedule of the selected plan.

Request body

`name`	The name you want to give to the test schedule.
`executionId`	Test plan ID from the GET API.
`scheduleType`	How frequently you want to run tests — ONCE, HOURLY, DAILY, WEEKLY, MONTHLY.
`status`	Status of the schedule, e.g. ACTIVE.
`nextInterval`	Date and time (yyyy-MM-dd'T'HH:mm:ss.SSS) to trigger the test plan.
`timezone`	The timezone you want to follow.

Response attributes

`id`	The ID of the schedule.
`executionId`	Test plan ID from the GET API.
`name`	The name given to the test schedule.
`comments`	Comments on the schedule.
`scheduleType`	How frequently tests run — ONCE, HOURLY, DAILY, WEEKLY, MONTHLY.
`nextInterval`	Epoch timestamp of the next trigger interval.
`nextIntervalUTC`	Next trigger interval in UTC.
`createdById`	The user ID of the creator.
`createdDate`	Date when the schedule was created.
`updatedById`	The user ID of the updater.
`updatedDate`	Date when the schedule was updated.
`status`	Status of the schedule.

Request

curl -X PUT \
  'https://app.testsigma.com/api/v1/schedule_executions/{scheduleId}' \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Updated schedule",
    "executionId": 180,
    "scheduleType": "WEEKLY",
    "status": "ACTIVE",
    "nextInterval": "2022-12-20T15:28:00.000",
    "timezone": "PST"
  }'

const response = await fetch('https://app.testsigma.com/api/v1/schedule_executions/{scheduleId}', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer <API_KEY>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
      "name": "Updated schedule",
      "executionId": 180,
      "scheduleType": "WEEKLY",
      "status": "ACTIVE",
      "nextInterval": "2022-12-20T15:28:00.000",
      "timezone": "PST"
  })
});
const data = await response.json();

import requests

response = requests.put(
  'https://app.testsigma.com/api/v1/schedule_executions/{scheduleId}',
  headers={
    'Authorization': 'Bearer <API_KEY>',
    'Content-Type': 'application/json'
  },
  json={
      "name": "Updated schedule",
      "executionId": 180,
      "scheduleType": "WEEKLY",
      "status": "ACTIVE",
      "nextInterval": "2022-12-20T15:28:00.000",
      "timezone": "PST"
  }
)
data = response.json()

Response200 OK

{
  "id": 16,
  "executionId": 180,
  "name": "Updated schedule",
  "comments": null,
  "scheduleType": "WEEKLY",
  "nextInterval": 1671578880000,
  "nextIntervalUTC": "2022-12-20T23:28:00Z",
  "createdById": 9,
  "createdDate": 1670995456000,
  "updatedById": 10,
  "updatedDate": 1671548631732,
  "status": "ACTIVE"
}

Was this page helpful?