Properties

Cancel a bulk enrichment job

DELapi.modelmatch.com/v1/properties/enrich-bulk/{jobId}

Cancels a queued or running bulk enrichment job.

The job is marked cancelled immediately; the container running it notices at its next progress tick and stops. Enrichment is billed once, at the end, so a cancelled job is never charged — no credits are debited and there is nothing to refund. Properties already enriched stay in the cache, so re-running later is cheaper.

Cancelling a job that has already finished (or was already cancelled) returns 409 and changes nothing.

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Path parameters

jobIdstringrequired

Job ID from POST /v1/properties/enrich-bulk

Responses

200objectJob cancelled; body is its settled status

Show attributes

billingStatusenum

Outcome of the job's single finalize debit, taken before the results are released: charged, capped (member balance / spend cap / daily cap declined it — the job fails insufficient_credits), billing_error (the debit could not be made — the job fails billing_unavailable), or none (nothing matched). Absent until billing has run, and on older rows.

Options:chargedcappedbilling_errornone

chargedCountintegerrequired

Intended charge — matched rows tallied during the run. NOT necessarily what was billed; read creditsCharged for the actual debit and billingStatus for why they differ.

completedAtstring

creditsChargedinteger

Credits ACTUALLY debited (0 when the finalize debit was rejected/failed). Absent only on rows written before the field existed, where enrichment billed 1 credit per match and chargedCount was the credit amount.

downloadUrlstring

Stable, shareable download link for the completed results. Forces a file download (with a friendly filename) and stays valid for 7 days after completion. Present once status is completed. This is the link to hand to a user or send by email.

errorstring

Why the job failed. insufficient_credits = the charge was declined (balance, spend cap or daily cap), no results released. billing_unavailable = the charge could not be made, no results released — retry.

failedintegerrequired

fromCacheintegerrequired

jobIdstringrequired

resultsUrlstring

Direct download URL for the completed results. Long-lived per request but changes on each poll; prefer downloadUrl for a stable link to share.

startedAtstring

statusenumrequired

Options:queuedrunningcompletedfailedcancelled

succeededintegerrequired

totalintegerrequired

401objectAuthentication required

403objectCaller does not own this job

404objectJob not found (or expired past 30d TTL)

409objectJob already finished — nothing to cancel

curl -X DELETE "https://api.modelmatch.com/v1/properties/enrich-bulk/<jobId>" \
  -H "x-api-key: $MODEL_MATCH_API_KEY"

import { createClient } from "@model-match/api";

const client = createClient({ apiKey: process.env.MODEL_MATCH_API_KEY });

const { data, error } = await client.properties.cancelEnrichBulkJob({
  path: {
    jobId: "<jobId>"
  }
});

import os
import requests

res = requests.delete(
    "https://api.modelmatch.com/v1/properties/enrich-bulk/<jobId>",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
)
data = res.json()

200 response

{
  "billingStatus": "charged",
  "chargedCount": 123,
  "completedAt": "<string>",
  "creditsCharged": 123,
  "downloadUrl": "<string>",
  "error": "<string>",
  "failed": 123,
  "fromCache": 123,
  "jobId": "<string>",
  "resultsUrl": "<string>",
  "startedAt": "<string>",
  "status": "queued",
  "succeeded": 123,
  "total": 123
}