ORorq-ai
Agent Schedules

Update schedule

Partially updates a schedule. Any omitted field is left unchanged. Changing expression or type (or reactivating from inactive) reschedules the next run and bumps generation; payload-only and agent_tag-only changes leave the firing cadence in place.

patch/v3/agents/{agent_key}/schedules/{schedule_id}

Request

  • Base URL
    https://my.orq.ai
  • URL
    https://my.orq.ai/v3/agents/{agent_key}/schedules/{schedule_id}
  • Auth
    HTTP bearer

Path parameters

agent_keystring required

The unique routing key of the agent the schedule belongs to.

schedule_idstring required

The schedule's ULID, as returned from create.

Request body

agent_tagstring

Change the pinned agent version.

display_namestring

Rename the schedule.

expressionstring

Update the schedule expression. Same 6-field cron shapes as create; minimum firing cadence is 1 hour.

is_activeboolean

Activate or deactivate the schedule. Deactivating stops future executions; activating schedules future executions using the current values.

type'cron'

Change the schedule type. Only cron is accepted. Changing the type or expression reschedules future executions and increments generation.

Response

Schedule updated.

_idstring required

ULID identifying this schedule.

agent_keystring required
agent_tagstring

Pinned agent version. Omit to always run the agent's current active version.

createdstring date-time required
created_by_idstring required

ID of the API key that created the schedule.

display_namestring

Human-readable name of the schedule. Omitted for schedules created before display names were required.

expressionstring required

6-field cron expression. Schedules stored before the cron-only restriction may also return an @every duration or an @at RFC3339 timestamp.

generationinteger required

Monotonic counter incremented when the schedule's firing cadence changes, allowing outdated in-flight triggers to be ignored.

is_activeboolean required

Whether the schedule is currently firing. Legacy once schedules flip to false automatically after firing.

last_triggered_atstring date-time

Timestamp of the most recent firing, if any.

trigger_countinteger required

Total firings since creation or last expression/type change.

type'cron' | 'once' | 'interval' required

Schedule type. Only cron can be created or updated; once and interval only appear on schedules stored before that restriction.

updatedstring date-time required
updated_by_idstring

ID of the API key that last updated the schedule. Omitted until the schedule is updated.

Changes

No operation changes recorded.