Skip to main content
PUT
Update a scheduled task. Only the supplied fields change.

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Path Parameters

task_id
string
required

Body

application/json

Fields to change

Request body for updating a scheduled task. Only supplied fields change.

companyId
string

Company ID. Optional when the API key is a company key.

name
string

Short descriptive name

prompt
string

The instruction the employee executes on every run

scheduleType
enum<string>

one_time, recurring, or heartbeat

Available options:
one_time,
recurring,
heartbeat
scheduledAt
string

One-time tasks: ISO 8601 datetime to run at

recurringConfig
object

Schedule details for recurring and heartbeat tasks

timezone
string

IANA timezone the schedule is expressed in

contextSettings
object

Tool and context settings for the run

status
enum<string>

active or paused

Available options:
active,
paused,
completed

Response

The updated task

Scheduled task

id
string
companyId
string
userId
string

User who owns the task

employeeId
string
name
string
prompt
string
scheduleType
string

one_time, recurring, or heartbeat

scheduledAt
string

One-time tasks: ISO 8601 run time

recurringConfig
object

Recurring or heartbeat schedule details

contextSettings
object

Tool and context settings for runs

timezone
string
nextRunAt
string

ISO 8601 time of the next run, null when none

lastRunAt
string

ISO 8601 time of the last run, null when never run

status
string

active, paused, or completed

runCount
integer
templateId
string
templateVersion
integer
createdDate
string
updatedDate
string