Skip to main content
POST
Cancel a service job

Authorizations

Authorization
string
header
required

API key ret_live_… created in Settings → API keys.

Path Parameters

id
string
required

Response

Status after cancellation.

job_id
string
service
string
status
enum<string>
Available options:
queued,
running,
completed,
failed,
cancelled
attempt
integer

Number of times the provider call started (the current claim included). Becomes 2 if a restart resumed a started job. A restart before the call started does not count.

reused
boolean

true when the answer came from one your organization already paid for (a recent answer, or a job another list started): nothing more was charged for this answer, and credits.charged keeps only what earlier attempts of its job paid (0 on a batch line that points to a job it did not create). On a batch line, also true for a line that points to a job another line or list created.

credits
object
result
object

Present only if completed.

error
object

Present only if failed. Never a negative answer. The failed attempt costs nothing, except the Deep agent's miss price when a contact lookup's Deep agent finished its search. A call cut by a timeout can still be billed if the provider's answer lands just after the cut. A line that ends worker_lost can also be billed: its call may have run, and been paid, before the worker was lost. credits.charged gives what the line really cost, earlier attempts included.

created_at
string<date-time>
started_at
string<date-time> | null

When the provider call first started. Null while the job waits.

completed_at
string<date-time> | null
ok
boolean
poll_url
string