Jobs

Cancel Job

Changed on

Cancel an active job.

A held execution answers 409: it settles only through its hold (decide, withdraw or expiry), never by cancelling the job.

post/jobs/{job_id}:cancel

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /jobs/{job_id}:cancel
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL /authorize, token URL /oauth/token)

Path parameters

job_idstring required

ID of the job.

Example:job_6968b3985e8c9902207afaeb

Response

Successful Response

actor_idstring nullable

Subject that enqueued the job. Null only for legacy rows with no actor.

actor_typestring required

Kind of actor that enqueued the job: 'user' or 'agent'. Opaque string: historical rows may carry a retired type such as 'service_account'.

created_atstring date-time required

When the job was created (RFC 3339).

errorstring nullable

Error message recorded for the job; null if none.

execution_idstring nullable

ID of the execution record linked to the job, if any.

job_idstring required

Unique ID of the job.

kindstring required

Kind of job, e.g. import or execution.

statusstring required

Lifecycle state: queued, running, completed, failed, cancelled or dead_letter.

updated_atstring date-time nullable

When the job was last updated (RFC 3339); null if never updated.

Example response

{
  "_links": {
    "execution": "https://jentic.example.com/executions/exec_6968b3982706c619fe73f0cf",
    "result": "https://jentic.example.com/jobs/job_6968b3985e8c9902207afaeb/result",
    "self": "https://jentic.example.com/jobs/job_6968b3985e8c9902207afaeb"
  },
  "actor_id": "agnt_6968b3984d1c238dbe7e2e29",
  "actor_type": "agent",
  "created_at": "2026-01-15T09:30:00Z",
  "error": "Upstream returned HTTP 502 Bad Gateway",
  "execution_id": "exec_6968b3982706c619fe73f0cf",
  "job_id": "job_6968b3985e8c9902207afaeb",
  "kind": "execution",
  "status": "completed",
  "updated_at": "2026-01-15T09:30:05Z"
}

Changes