Skip to main content

Cancel a list build

Request cancellation of a list-build job and receive its cancellation result or current job summary.

DELETE/api/list-builds/{job_id}
HTTP referenceScope search:runUpdated September 27, 2026

This page documents the canonical HTTP contract for this endpoint.

This endpoint accepts no request body. If the job is cancelled, it returns {"status":"cancelled","job_id":"…"}. If it cannot cancel the job, it returns the current summarized job instead; inspect that status rather than assuming the request stopped execution.

Authentication and organization context are required. Developer API keys need search:run. Unknown jobs return 404; a missing organization context returns 400.

Path parameters

  • job_idrequired

    string

    List-build ID returned by POST /api/list-builds.

Errors

StatusMeaning
400organization_id is required.
401Authentication required.
403Developer API key lacks search:run.
404List build job not found.

Docs