Skip to main content
POST
Preview Schedule

Code Examples

Headers

Authentication is performed via the Authorization: Bearer YOUR_API_KEY header.
integer
required
ID of the workspace. Required for all Digital Employees API endpoints.

Body Parameters

At least one of heartbeat_cron or heartbeat_schedule_json must be provided in the request body.
string
Cron expression defining the schedule (e.g. 0 9 * * 1-5 for weekdays at 9 AM). At least one of heartbeat_cron or heartbeat_schedule_json must be provided.
object
Schedule builder config object. Alternative to heartbeat_cron. At least one of heartbeat_cron or heartbeat_schedule_json must be provided.
string
Timezone for evaluating the schedule (e.g. America/Sao_Paulo). Defaults to UTC if not provided.

Response