Skip to main content
PUT
/
api
/
v1
/
workflow
/
public
/
scheduled
/
:schedule_id
/
pause
curl -X PUT "https://app.refold.ai/api/v1/workflow/public/scheduled/{schedule_id}/pause" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "linked_account_id: YOUR_LINKED_ACCOUNT_ID"

{
  "_id": "6a315b7ad396207fd2547678",
  "workflow": "6a17f312aae660322b26883e",
  "config_id": "user_12345",
  "linked_account_id": "user_12345",
  "trigger_type": "cron",
  "cron_patten": "0 9 * * 1",
  "status": "paused",
  "inactive": true
}
Pause a schedule so it stops firing. The schedule is retained and can be resumed later. After pausing, status is paused and inactive is true.

​
Authentication

​
x-api-key
string
required
Your Refold API key.
​
linked_account_id
string
required
The linked account that owns the schedule.

​
Path Parameters

​
schedule_id
string
required
The schedule ID to pause.

​
Response

Returns the schedule with status: "paused" and inactive: true.
{
  "_id": "6a315b7ad396207fd2547678",
  "workflow": "6a17f312aae660322b26883e",
  "config_id": "user_12345",
  "linked_account_id": "user_12345",
  "trigger_type": "cron",
  "cron_patten": "0 9 * * 1",
  "status": "paused",
  "inactive": true
}

curl -X PUT "https://app.refold.ai/api/v1/workflow/public/scheduled/{schedule_id}/pause" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "linked_account_id: YOUR_LINKED_ACCOUNT_ID"