Summary
Updates an automation's schedule
Description
Updates an automation's schedule properties (only)
Route
PUT /automation_catalog/automations/:id/schedule
Roles
admin
other
apiread
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| id |
string |
yes |
Unique id of the automation |
| options |
object |
yes |
Scheduling based options |
Copied to Clipboard
{
"options": {
"nextRunAt": "2019-11-25T22:51:39.201Z",
"repeatInterval": null,
"disabled": false
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"options": {
"title": "options",
"type": "object",
"properties": {
"nextRunAt": {
"oneOf": [
{
"type": "string",
"examples": [
"2019-11-25T22:51:39.201Z"
],
"format": "date-time",
"description": "Agenda property defining when the next run will process, stored in UTC."
},
{
"type": "null"
}
]
},
"repeatInterval": {
"oneOf": [
{
"type": "string",
"minLength": 1,
"description": "Agenda property defining how often an automation will repeat. Stored in human interval time format (https://github.com/agenda/human-interval).",
"examples": [
"1 hour",
"1 day",
"3 weeks",
"2 months"
]
},
{
"type": "null"
}
]
},
"disabled": {
"type": "boolean"
}
},
"required": [],
"minProperties": 1
}
},
"required": [
"options"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| result |
object |
result of scheduling |
Copied to Clipboard
{
"status": "cupidatat Excepteur voluptate enim",
"response": {
"message": "string"
}
}
Copied to Clipboard
{
"title": "result",
"type": "object",
"properties": {
"status": {
"type": "string"
},
"response": {
"message": "string"
}
},
"required": []
}
