POST
/
workflows
/
schedules
/
create
Create workflow schedule
curl --request POST \
  --url https://api.kaizenautomation.com/workflows/schedules/create \
  --header 'Content-Type: application/json' \
  --data '{
  "cronExpression": "<string>",
  "timezone": "<string>",
  "params": {},
  "enabled": true,
  "loginId": "<string>",
  "workflowId": "<string>"
}'
{
  "id": "<string>",
  "cronExpression": "<string>",
  "timezone": "<string>",
  "params": {},
  "enabled": true,
  "logins": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ]
}

Body

application/json

Create workflow schedule parameters

​
cronExpression
string
required

Cron expression defining when the workflow should run. Supports standard Unix cron format with optional seconds field (e.g.,0 0 * * * for daily at midnight, */5 * * * * for every 5 minutes). Uses cron-parser for validation and parsing.

​
timezone
string
required

Timezone for cron expression. See List of tz database time zones for valid values.

​
params
object | null
required

Parameters for the schedule

​
enabled
boolean
required

Whether the schedule is enabled or disabled

​
loginId
string
required

External ID of the login to set schedule for

​
workflowId
string
required

ID of the workflow to set schedule for

Response

Schedule created successfully

​
id
string
required

ID of the workflow schedule

​
cronExpression
string
required

Cron expression defining when the workflow should run. Supports standard Unix cron format with optional seconds field (e.g.,0 0 * * * for daily at midnight, */5 * * * * for every 5 minutes). Uses cron-parser for validation and parsing.

​
timezone
string
required

Timezone for cron expression. See List of tz database time zones for valid values.

​
params
object | null
required

Parameters for the schedule

​
enabled
boolean
required

Whether the schedule is enabled or disabled

​
logins
object[]
required

List of logins to execute the workflow with.