POST /api/v1/forward/schedules/{schedule_id}/pause
Pauses a Schedule. Paused schedules do not run on trigger policy and cannot be manually run.
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT> |
Content-Type | No | application/json if a body is sent. |
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 OKResponse fields
Returns the updated Schedule object withstatus=paused.
Errors
| HTTP | Type | Code | Trigger |
|---|---|---|---|
| 401 | authentication_error | authentication_required | PAT invalid or expired. |
| 404 | not_found_error | schedule_not_found | Schedule does not exist. |
| 409 | invalid_request_error | schedule_archived | Schedule is archived. |
Notes
- The body may be omitted or an empty JSON object
{}. - Current design only exposes manual pause reasons.