Agents

Cancel a bulk-delivery job for agents

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

Cancels a queued or running agents 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/agents/bulk-delivery/{jobId} for the settled state.

Authorization

x-api-key<token>

In: header

Path Parameters

jobId*string

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

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/v1/agents/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"
}

Zip-code volume breakdown POST

Ranks the agent's CLOSED sales (status sold, a real sale price — rentals and lease listings excluded, duplicate records of one sale counted once) by this dimension. The same population `POST /v1/agents/{id}/sales` returns with `flatFilters.mlsStatus: "SLD"` and the agent analytics routes count. `side` narrows to the deals the agent was on that side of (`buyer` includes deals on both sides; `buyer` + `listing` = `any`).

Count agents matching filters POST

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