Sign in

v2

latestOpenAPI 3.1.02026-07-31822441.6 KB

Create jobs schedule

Create a new schedule for a tenant

put/{env_id}/{flow_id}/{tenant_id}/jobs/schedule

Path parameters

env_idstring required

ID of environment

flow_idstring required

ID of flow

tenant_idstring required

ID of tenant

Request body

job_type'read' | 'write'

The type of job within the v2 flow to manipulate. Accepts "read" or "write."

schedule_expressionstring required

cron expression defining how often sync should occur e.g. cron(0 0 * * *)

state'DISABLED' | 'ENABLED'

Whether this schedule should be DISABLED or ENABLED

schedule_jitter_minutesinteger nullable

Jitter window in minutes for default schedules. Only allowed when tenant is default; set to null to clear.

Response

200

ScheduleExpressionstring
Statestring
ScheduleJitterMinutesinteger nullable

Example response

{
  "ScheduleExpression": "cron(0 0 ? * SUN *)",
  "State": "DISABLED",
  "ScheduleJitterMinutes": 60
}