PSpscrpt
jobs

Cancel a job

Changed on

Best effort; rows already processed stay processed.

post/jobs/{job_id}/cancel

Request

  • Base URL
    https://api.pscrpt.com/v1
  • URL
    https://api.pscrpt.com/v1/jobs/{job_id}/cancel
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://api.pscrpt.com/oauth/authorize
      Token URL: https://api.pscrpt.com/oauth/token

Path parameters

job_idstring required

Headers

Idempotency-Keystring

Deduplicates retries for 24 hours: the same key returns the original response with Idempotency-Replayed: true; the same key with a different body returns 409 idempotency_key_reused.

Postscript-Versionstring date
Example:2026-07-23

Overrides the key's pinned API revision for this request.

Response

The job as it stands after the cancel request. A queued job is cancelled at once; a running job stops at its next checkpoint and reads cancelled on a later retrieve.

Example response

{
  "data": {
    "completed_at": "2026-07-23T17:32:01.123456Z",
    "created_at": "2026-07-23T17:32:01.123456Z",
    "updated_at": "2026-07-23T17:32:01.123456Z"
  }
}

Changes