Enrichment

Cancel Enrichment Job

Cancel a running or paused job. Free, and it cannot be undone.

Records already enriched keep their data and their charge; nothing further is enriched.

post/enrichment/jobs/{job_id}/cancel

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/enrichment/jobs/{job_id}/cancel
  • Auth: HTTP bearer

Path parameters

job_idstring required

Enrichment job id (UUID).

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

reasonstring nullable

Response

Successful Response

dataEnrichmentPayload required

One enrichment object, open-shaped.

Open on purpose: a workbench column set is defined by the CUSTOMER at runtime, and the enrichment result shapes grow with every provider added. Pinning them would drop whatever a provider returned that this contract had not caught up on, which on an enrichment surface is the data the customer paid for.

Changes

No recorded changes to this operation across all 2 revisions of this API.