Update a scheduled job

POST 
/api/v1/scheduler/update-job

Updates the provided schedule settings. Only included fields change; omitted fields remain unchanged.

Timing changes

Section ID: DOC-CP-scheduling-api-updateJob#timing-changes

The scheduler applies timing edits before returning by cancelling and reinserting the scheduled entry. This cannot undo an HTTP callback already dispatched or a business action your receiver has accepted.

nextTriggerAt on the returned job is the scheduling snapshot after the update; it can change as work advances. Do not infer wall-clock firing precision or business completion from that timestamp.

The following access conditions are preserved as declared intent and are not implemented by generated code: Authorized scoped domain action.

Use this in a guide: Manage jobs

Request

Responses

200

Scheduled job updated

Rename an existing job using its returned scheduleId.

Section ID: DOC-CP-scheduling-api-updateJob#example-scheduled-jobs-updateJob-request

Request example

{
  "scheduleId": "sched_a1b2c3d4e5f60718",
  "name": "Weekday morning digest"
}

Guide request for 2. Save a new delivery time. Replace example resource identifiers with your own authorized values.

Section ID: DOC-CP-scheduling-api-updateJob#example-cookbook-core-platform-scheduling-managing-03-request

Request example

{
  "scheduleId": "sched_a1b2c3d4e5f60718",
  "cronExpression": "0 10 * * 1-5"
}

Illustrative response shape; omitted default fields and actual outcomes depend on the operation.

Section ID: DOC-CP-scheduling-api-updateJob#example-scheduled-jobs-updateJob-response

Response example

{
  "schedule": {
    "scheduleId": "sched_a1b2c3d4e5f60718",
    "tenantId": "example_123",
    "projectId": "example_123",
    "ownerSubject": "example",
    "name": "example",
    "description": "example",
    "scheduleType": "SCHEDULE_TYPE_CRON",
    "cronExpression": "0 9 * * *",
    "timezone": "example",
    "scheduledAt": "2026-09-16T12:00:00Z",
    "intervalSeconds": 1,
    "target": {
      "url": "https://example.com/callback",
      "method": "example",
      "kind": "example"
    },
    "state": "SCHEDULE_STATUS_ACTIVE",
    "retryPolicy": {
      "maxAttempts": 1,
      "initialBackoffMs": 1,
      "maxBackoffMs": 1
    },
    "metadata": {
      "example": "value"
    },
    "autoPauseThreshold": 1,
    "externalId": "example_123",
    "createdAt": "2026-09-16T12:00:00Z",
    "createdBySubject": "example",
    "updatedAt": "2026-09-16T12:00:00Z",
    "updatedBySubject": "example",
    "pausedAt": "2026-09-16T12:00:00Z",
    "pausedBySubject": "example",
    "pausedReason": "example",
    "resumedAt": "2026-09-16T12:00:00Z",
    "resumedBySubject": "example",
    "deletedAt": "2026-09-16T12:00:00Z",
    "deletedBySubject": "example",
    "lastTriggeredAt": "2026-09-16T12:00:00Z",
    "nextTriggerAt": "2026-09-16T12:00:00Z",
    "triggerCount": "1",
    "failureCount": "1",
    "consecutiveFailureCount": "1"
  },
  "effectiveAt": "example"
}

Document ID: DOC-CP-scheduling-api-updateJob. Section identities and revisions.

Section	Stable reference
Update a scheduled job	DOC-CP-scheduling-api-updateJob#overview
Request	DOC-CP-scheduling-api-updateJob#request
Responses	DOC-CP-scheduling-api-updateJob#responses