curl --request PUT \
--url https://api.gocobalt.io/api/v1/workflow/public/scheduled/:schedule_id/pause \
--header 'x-api-key: <api-key>'
{
"_id": "67becf62f29636d291eaadc0",
"event_id": "67becf62f29636d291eaadbf",
"workflow": "663c73e4608a784bacac384a",
"linked_account_id": "tim-cook",
"environment": "test",
"org_id": "65c9ef72f4b95fce32e8ccf8",
"cron_patten": "*/6 * * * *",
"inactive": true,
"registered_by_api": true,
"options": {
"currentDate": "2025-02-26",
"endDate": "2025-02-28",
"startDate": "2025-02-27",
"tz": "Asia/Kolkata"
},
"trigger_type": "cron",
"trigger_interval": [],
"schedule_added_at": "2025-02-26T08:22:58.080Z",
"updatedAt": "2025-02-26T08:22:58.080Z"
}
This API pauses a cron schedule by its ID.
Request description
Path Parameters
The id of the schedule that you want to pause.
Response description
ID of the registered cron
ID or Alias of the workflow
Linked Account ID for which cron is registered
Environment in which cron registered
Cron Pattern used for schedule register.
The schedule is inactive or not.
Whether the cron is registered using API.
Cron body sent in the request
End date for the schedule
Start date of the schedule
Timezone for the schedule.
Array of the interval dates for which the schedule is registered. It is empty if cron trigger_type is used.
Timestamp when schedule was added
Timestamp of schedule updation.
{
"_id": "67becf62f29636d291eaadc0",
"event_id": "67becf62f29636d291eaadbf",
"workflow": "663c73e4608a784bacac384a",
"linked_account_id": "tim-cook",
"environment": "test",
"org_id": "65c9ef72f4b95fce32e8ccf8",
"cron_patten": "*/6 * * * *",
"inactive": true,
"registered_by_api": true,
"options": {
"currentDate": "2025-02-26",
"endDate": "2025-02-28",
"startDate": "2025-02-27",
"tz": "Asia/Kolkata"
},
"trigger_type": "cron",
"trigger_interval": [],
"schedule_added_at": "2025-02-26T08:22:58.080Z",
"updatedAt": "2025-02-26T08:22:58.080Z"
}
