Resume a paused Forward Schedule.
POST /api/v1/forward/schedules/{schedule_id}/unpause
Restores a paused Schedule to active status.
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT or SAT> |
Idempotency-Key | No | Optional idempotency key for unsafe requests. |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
schedule_id | string | Yes | Forward Schedule ID. |
Example request
Example response
HTTP 200 OK
Response fields
Returns the updated Schedule object, with status=active.
Errors
| HTTP | Type | Code | Trigger |
|---|---|---|---|
| 404 | not_found_error | schedule_not_found | The Schedule does not exist or does not belong to the current owner. |
| 409 | invalid_request_error | schedule_archived | The Schedule is archived. |
| 409 | invalid_request_error | schedule_channel_unavailable | The delivery channel does not exist, is inaccessible, or the delivery configuration is unavailable; update or clear the Schedule sinks, then retry. |
| 409 | invalid_request_error | schedule_channel_disabled | The delivery channel is disabled; enable the channel, or update or clear sinks, then retry. |
| 409 | invalid_request_error | schedule_channel_binding_changed | The channel binding has changed and no longer meets the current task requirements; update or clear sinks, then retry. |
| 409 | invalid_request_error | schedule_channel_pairing_unavailable | The channel pairing is no longer valid or accessible; pair again and update sinks, or clear sinks, then retry. |
| 409 | invalid_request_error | schedule_not_active | Other resume conditions are not met, such as an unavailable Identity, Template, or Environment dependency, an invalid trigger policy, or no future trigger time within the monitoring window. |
| 401 | authentication_error | - | The PAT or SAT is invalid or expired. |
| 403 | permission_error | identity_mismatch | An Identity-bound SAT requests or operates on a Schedule outside its bound Identity. |
Example response when the channel does not exist
HTTP 409 Conflict
{"sinks": []} to clear the delivery configuration, then call the unpause endpoint again. After clearing it, the task no longer delivers results through that channel; the resume operation itself does not repair or recreate the channel.
Notes
- Resuming does not immediately create a Schedule Run.
- Related dependencies and trigger configuration are validated before resuming. A paused state can be resumed; dependency issues such as an invalid channel prevent resuming.
- If resuming fails, the task status, version, and next trigger time remain unchanged; a paused task remains paused.
- For cron / interval tasks, a future trigger time that is still valid is retained; if missing or expired, it is recalculated using the current trigger rules and monitoring window, without catching up on missed triggers. If there is no future trigger time within the window,
schedule_not_activeis returned.