Schedules

Update a schedule

put/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 updated

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.337

    • 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

    • 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

    • the request property format changed from uuid to no format

      request-property-type-changed

    • added the new optional request property

      new-optional-request-property

    • the request property became nullable

      request-property-became-nullable

    • the request property became nullable

      request-property-became-nullable

    • the request property became not nullable

      request-property-became-not-nullable

    • the request property became not nullable

      request-property-became-not-nullable

    • removed the request property

      request-property-removed