Skip to main content
PUT
Create or replace a group's schedule

Authorizations

Authorization
string
header
required

API key authentication using Bearer token format. The CLI's ta auth access tokens are also accepted; because they name a user rather than a workspace, a user in several workspaces selects one with the x-testerarmy-team header (workspace id or slug).

Path Parameters

groupId
string<uuid>
required

Test group ID

Body

application/json
frequency
enum<string>
required

Preset cadence. The interval presets take minute; daily adds hour; weekly adds hour and dayOfWeek; custom takes cronExpression.

Available options:
every_1h,
every_3h,
every_6h,
every_12h,
daily,
weekly,
custom
minute
integer
default:0

Minute of the hour (0-59). Defaults to 0. Ignored for custom.

Required range: 0 <= x <= 59
hour
integer

Hour of the day (0-23) in timezone. Required for daily and weekly.

Required range: 0 <= x <= 23
dayOfWeek
integer

0 = Sunday through 6 = Saturday. Required for weekly.

Required range: 0 <= x <= 6
cronExpression
string

Standard 5-field cron (minute hour day-of-month month day-of-week), e.g. "*/30 * * * *" for every 30 minutes. Seconds are not supported. Required for custom.

Required string length: 1 - 100
timezone
string
default:UTC

IANA timezone the schedule is evaluated in, e.g. "Europe/Warsaw". Defaults to UTC.

Required string length: 1 - 64
name
string

Display name shown in the dashboard.

Required string length: 1 - 120
projectEnvironmentId
string<uuid> | null

Saved environment the schedule runs against, from the project's environments. Omit or pass null for Production. PR Preview cannot be scheduled.

Response

Existing schedule replaced

schedule
object
required