POST /api/v1/forward/schedules/{schedule_id}/archive
Archives a Schedule without deleting historical Schedule Runs. Archived schedules are not triggered and cannot be updated, paused, unpaused, or manually run.
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT> |
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 archived Schedule object witharchived_at set.
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 already archived. |
Notes
- Archive is a lifecycle terminal state for the Schedule.
- Schedule Runs remain queryable after the Schedule is archived.