Schedules

Update schedule

Compare-and-set update of name, description, agent_id, agent_version, input, or model. An empty model clears the saved override; omission preserves it. Explicit null values are rejected. Changing agent_id without agent_version pins that Agent's current version.

patch/v1/schedules/{schedule_id}

Request

  • Base URL: https://api.sandbase.ai
  • URL: https://api.sandbase.ai/v1/schedules/{schedule_id}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Request body

namestring
descriptionstring
agent_idstring
agent_versioninteger
inputstring
modelstring

Model override. Empty string clears the override; omission preserves it. Null is rejected.

row_versioninteger required

Response

Schedule

idstring required

Service (svc_) or Schedule (sch_) ID.

kind'service' | 'schedule' required
namestring required
descriptionstring required
agent_idstring required
agent_versioninteger required

Pinned Agent version.

inputstring required
modelstring
status'active' | 'paused' | 'archived' required
row_versioninteger required

Schedule row_version also advances after every scheduled tick.

next_run_atstring date-time
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.