メインコンテンツへスキップ
POST /api/v1/forward/schedules/{schedule_id}/pause Schedule を一時停止します。一時停止中のスケジュールはトリガーポリシーに基づいて実行されず、手動実行もできません。

​
Headers

HeaderRequiredDescription
AuthorizationYesBearer <PAT>
Content-TypeNoボディを送信する場合は application/json。
Idempotency-KeyNo安全でないリクエスト向けの任意のべき等キー。

​
Path parameters

ParameterTypeRequiredDescription
schedule_idstringYesForward Schedule ID。

​
Example request

curl -s -X POST 'https://api.qoder.com/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

status=paused が設定された更新後の Schedule オブジェクトを返します。

​
Errors

HTTPTypeCodeTrigger
401authentication_errorauthentication_requiredPAT が無効または期限切れです。
404not_found_errorschedule_not_foundSchedule が存在しません。
409invalid_request_errorschedule_archivedSchedule はアーカイブ済みです。

​
Notes

  • ボディは省略するか、空の JSON オブジェクト {} にできます。
  • 現在の設計では手動の一時停止理由のみを公開します。

スケジュールを再開する

スケジュールを実行する