All Products
Search
Document Center

Qoder CN Series:Pause a schedule

Last Updated:Jul 15, 2026

Pause an active Forward Schedule.

Request 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

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

Example response

HTTP 200 OK

{
  "id": "sched_019f00112233445566778899aabbccdd",
  "identity_id": "idn_019eabc123",
  "template_id": "tmpl_support",
  "name": "Daily tech brief",
  "status": "paused",
  "paused_reason": {
    "type": "manual"
  },
  "archived_at": null,
  "updated_at": "2026-06-22T12:00:00Z"
}

Response fields

Returns the updated Schedule object with status=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.