Skip to main content
POST
Cancel a job

Authorizations

Authorization
string
header
required

An API key from the console, starting ob_live_, sent as Authorization: Bearer <key>.

Path Parameters

jobId
string
required

The job's id, as the call that started it answered.

Required string length: 24
Pattern: ^[0-9a-fA-F]+$

Response

The job. It stops soon after, and then reads cancelled.

id
string
required
type
enum<string>
required

What the job does.

Available options:
email_verification,
people_enrichment,
list_enrichment
status
enum<string>
required

running until the job ends as succeeded, failed or cancelled.

Available options:
running,
succeeded,
failed,
cancelled
units
object[]
required

What the job produced so far, by price item.

createdAt
string<date-time>
required
listId
string

For a list enrichment, the list it runs over. What it finds is saved on the list's rows: read them with GET /v1/lists/{listId}/rows.

find
enum<string>

For an enrichment, what it looks for.

Available options:
email,
phone,
email_and_phone
providers
enum<string>

For an enrichment, where it looks.

Available options:
package,
waterfall
progress
object

How far the job got. Absent until it reports progress.

chargedUsd
string

What the job was charged, in US dollars as an exact six-decimal string. Present once it ended.

results
object[]

For a people enrichment, once it ended: every person's result, in the order the request named them. Shown to keys that can read enrichment.

finishedAt
string<date-time>

When the job ended. Absent while it runs.