Delete a scheduled job

POST 
/api/v1/scheduler/delete-job

Soft-deletes the schedule and stops future scheduling. The record is retained for inspection. Already dispatched work and its external effects are not undone by deleting the schedule.

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 deleted

Replace scheduleId with the ID returned when the job was created.

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

Request example

{
  "scheduleId": "sched_a1b2c3d4e5f60718"
}

Guide request for 4. Remove this reminder. Replace example resource identifiers with your own authorized values.

Section ID: DOC-CP-scheduling-api-deleteJob#example-cookbook-core-platform-scheduling-managing-05-request

Request example

{
  "scheduleId": "sched_a1b2c3d4e5f60718"
}

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

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

Response example

{
  "scheduleId": "sched_a1b2c3d4e5f60718"
}

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

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