Properties

Cancel a bulk-delivery job for properties

DELETE
/v1/properties/bulk-delivery/{jobId}

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.

Authorization

x-api-key<token>

In: header

Path Parameters

jobId*string

Job ID returned by POST /v1/properties/bulk-delivery

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/v1/properties/bulk-delivery/string"
{
  "billing": "credits",
  "billingReason": "first_party_push_target",
  "bytes": 0,
  "chargedCount": 0,
  "completedAt": "string",
  "creditLedgerId": "string",
  "creditsCharged": 0,
  "destination": {
    "targetId": "string",
    "type": "push-target"
  },
  "downloadUrl": "string",
  "entityType": "string",
  "error": "string",
  "estimatedTotal": 0,
  "format": "parquet",
  "jobId": "string",
  "processed": 0,
  "pushBatchId": "string",
  "resultsUrl": "string",
  "startedAt": "string",
  "status": "queued"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}

Cancel a bulk enrichment job DELETE

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.

Count properties matching filters POST

Return the exact number of properties matching the given filters. Accepts the same request body as `listProperties` (pagination and sort are ignored). Use this when you only need a total; to get the matching properties themselves, send the same request body to `listProperties`.