Sign in
Schedules

Patch a schedule

Partially updates a schedule by shallow-merging provided fields over the existing row.

patch/api/schedules/{id}

Path parameters

idstring required

Request body

keystring

Non-unique asset directory namespace (for example shared/ or personal/<user-id>/drafts/). Runtime write boundaries normalize and validate the canonical form.

namestring
descriptionstring
cronExpressionstring nullable
intervalMsinteger nullable
taskTemplatestring
taskTypestring
tagsstring[]
priorityinteger
targetAgentIdstring nullable
enabledboolean
timezonestring
modelstring nullable
modelTier'smol' | 'regular' | 'smart' | 'ultra' | 'null' nullable
nextRunAtstring nullable
targetType'agent-task' | 'workflow' | 'script'
workflowIdstring uuid nullable
scriptNamestring nullable
scriptArgsobject nullable

Response

Schedule patched

idstring uuid required
keystring required

Non-unique asset directory namespace (for example shared/ or personal/<user-id>/drafts/). Runtime write boundaries normalize and validate the canonical form.

namestring required
descriptionstring
cronExpressionstring
intervalMsinteger
taskTemplatestring
taskTypestring
tagsstring[]
priorityinteger
targetAgentIdstring
enabledboolean
lastRunAtstring date-time
nextRunAtstring date-time
createdByAgentIdstring
timezonestring
consecutiveErrorsinteger
lastErrorAtstring date-time
lastErrorMessagestring
modelstring
modelTier'smol' | 'regular' | 'smart' | 'ultra'
scheduleType'recurring' | 'one_time'
targetType'agent-task' | 'workflow' | 'script'
workflowIdstring uuid
scriptNamestring
scriptArgsobject
createdAtstring date-time required
lastUpdatedAtstring date-time required
createdBystring
updatedBystring
favoriteboolean

Changes

Changed in 6 of the 104 revisions of this API.226

  • 5657aaae1bab2See the full diff
    • ●

      the request property's max was set to 100.00

      request-property-max-set

    • ●

      the request property's min was set to 0.00

      request-property-min-set

  • 06cac6a7c5bc4See the full diff
    • ○

      added the media type application/json for the response with the status

      response-media-type-added

    • ○

      added the media type application/json for the response with the status

      response-media-type-added

    • ○

      added the media type application/json for the response with the status

      response-media-type-added

    • ○

      added the media type application/json for the response with the status

      response-media-type-added

  • cf533d6b49b01See the full diff
    • ▲

      the request property format changed from uuid to no format

      request-property-type-changed

  • f1022d5edb0d1See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

  • 13bd92bf5f041See the full diff
    • ○

      endpoint added

      endpoint-added

  • 0c910612f9ac1See the full diff
    • ▲

      api removed without deprecation

      api-removed-without-deprecation