Properties

Cancel a bulk enrichment job

DELETE
/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-key<token>

In: header

Path Parameters

jobId*string

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

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/v1/properties/enrich-bulk/string"
{
  "billingStatus": "charged",
  "chargedCount": 0,
  "completedAt": "string",
  "creditsCharged": 0,
  "downloadUrl": "string",
  "error": "string",
  "failed": 0,
  "fromCache": 0,
  "jobId": "string",
  "resultsUrl": "string",
  "startedAt": "string",
  "status": "queued",
  "succeeded": 0,
  "total": 0
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}

Submit a bulk-delivery job for originators POST

Queues an ECS task that dumps every matching originators document to S3 in the requested format. Returns 202 with a jobId; poll `GET /v1/originators/bulk-delivery/{jobId}` for status + the signed download URL. **Row limit.** Deliveries of up to 5,000 rows need no entitlement. Above that, the org's `bulk-delivery.originators` entitlement is required and its scope (row ceiling, row filters, allowed fields) governs the delivery; without it the request is rejected with 403 `entitlement_missing`. Pass `limit` at or below the ceiling to deliver a capped subset of a broader query. Email support@modelmatch.com to request a limit increase. Delivery is billed at 1 credit per row regardless of entitlement (deliveries submitted from the ModelMatch web app are not billed). **Push-target destination.** Pass `destination: { type: "push-target", targetId }` to have the finished rows sent to a configured push target instead of downloaded. The target is checked before anything is queued; a refusal returns the push target's status and `code` (`TARGET_NOT_FOUND` 404, `FORBIDDEN` 403, `PLAN_REQUIRED` 402, `TARGET_DISABLED` 409, `ENTITY_MISMATCH` 400). Limits and billing are the same as a file delivery.

Cancel a bulk-delivery job for properties DELETE

Cancels a queued or running properties delivery job. The job is marked `cancelled` immediately; the container running it notices on its next page boundary and stops. Because a delivery is billed once, at the end, **a cancelled job is never charged** — no credits are debited and there is nothing to refund. No partial file is written. Idempotent-ish: cancelling a job that has already finished (or was already cancelled) returns 409 and changes nothing. Poll `GET /v1/properties/bulk-delivery/{jobId}` for the settled state.