Skip to main content

Unpause a schedule

Resume a paused Forward Schedule.

POST /api/v1/forward/schedules/{schedule_id}/unpause Restores a paused Schedule to active status.

Headers

HeaderRequiredDescription
AuthorizationYesBearer <PAT or SAT>
Idempotency-KeyNoOptional idempotency key for unsafe requests.

Path parameters

ParameterTypeRequiredDescription
schedule_idstringYesForward Schedule ID.

Example request

curl -s -X POST 'https://api.qoder.com/api/v1/forward/schedules/sched_019f00112233445566778899aabbccdd/unpause' \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN"

Example response

HTTP 200 OK
{
  "id": "sched_019f00112233445566778899aabbccdd",
  "source": "api",
  "source_session_id": null,
  "identity_id": "idn_019eabc123",
  "template_id": "tmpl_support",
  "name": "Daily tech brief",
  "description": "Generate a daily technology news summary",
  "status": "active",
  "resources": [],
  "initial_events_version": 1,
  "initial_events": [
    {
      "type": "user.message",
      "content": "Summarize current technology news in five bullet points."
    }
  ],
  "execution": {
    "session_mode": "new_session",
    "max_concurrent_runs": 1,
    "max_attempts": 1,
    "timeout_ms": 300000
  },
  "trigger_policy": {
    "type": "cron",
    "expression": "0 9 * * *",
    "timezone": "Asia/Shanghai",
    "upcoming_runs_at": [
      "2026-06-23T01:00:00Z"
    ]
  },
  "environment_id": "env_019e64e01a137caf953ac2ac7b42ec5c",
  "sinks": [],
  "metadata": {},
  "created_at": "2026-06-22T10:00:00Z",
  "updated_at": "2026-06-22T12:10:00Z"
}

Response fields

Returns the updated Schedule object, with status=active.

Errors

HTTPTypeCodeTrigger
404not_found_errorschedule_not_foundThe Schedule does not exist or does not belong to the current owner.
409invalid_request_errorschedule_archivedThe Schedule is archived.
409invalid_request_errorschedule_channel_unavailableThe delivery channel does not exist, is inaccessible, or the delivery configuration is unavailable; update or clear the Schedule sinks, then retry.
409invalid_request_errorschedule_channel_disabledThe delivery channel is disabled; enable the channel, or update or clear sinks, then retry.
409invalid_request_errorschedule_channel_binding_changedThe channel binding has changed and no longer meets the current task requirements; update or clear sinks, then retry.
409invalid_request_errorschedule_channel_pairing_unavailableThe channel pairing is no longer valid or accessible; pair again and update sinks, or clear sinks, then retry.
409invalid_request_errorschedule_not_activeOther 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.
401authentication_error-The PAT or SAT is invalid or expired.
403permission_erroridentity_mismatchAn Identity-bound SAT requests or operates on a Schedule outside its bound Identity.

Example response when the channel does not exist

HTTP 409 Conflict
{
  "type": "error",
  "request_id": "00000000-0000-4000-8000-000000000000",
  "error": {
    "type": "invalid_request_error",
    "code": "schedule_channel_unavailable",
    "message": "Cannot resume schedule because its delivery channel no longer exists or is inaccessible. Update or clear the schedule sinks, then retry."
  }
}
This error means that the delivery channel the task depends on is unavailable. Use Update Schedule to replace it with a valid delivery target, or pass {"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_active is returned.