Homepage

admin_background_job_delete

Last edit: Nov 01, 2026

Deletes a scheduled, retrying or dead background job of this instance and
returns it. Raises "Job not found" when no such job exists; running jobs
cannot be deleted

admin_background_job_delete(
  id: ID!
): BackgroundJob

Arguments

id (ID)

Id of the background job, as returned by admin_background_jobs

Type

BackgroundJob

Job of the instance waiting in the background queue (scheduled, waiting for a
retry, dead) or currently running, for example one scheduled with the background tag

Questions?

We are always happy to help with any questions you may have.

contact us