pause_schedule
Stop a schedule firing, keeping its configuration. Resume it with resume_schedule.
Deliberately not plan-gated: an organization whose plan no longer includes schedules must still be able to stop what it already has running.
Parameters#
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
schedule_id | string | yes | The schedule id |
Returns#
The schedule, with status: "paused".
Errors#
error_type | When |
|---|---|
auth_error | Missing / invalid API key |
not_found | Unknown schedule id, or one outside your organization |