Integrations

Send records to your HubSpot account

POST
/v1/integrations/hubspot/push

Sends the given Model Match records into the HubSpot account you have connected, using the field mapping your workspace configured. Existing records are matched and updated rather than duplicated, so sending the same list twice does not create it twice. Every id you send comes back with an outcome — some records failing is normal and does not fail the rest. At most 100 records per request; send larger lists in batches. There is no undo: use dryRun first to see exactly what would be written. Charged per record actually written, at the same rate as fetching that record.

Authorization

x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/integrations/hubspot/push" \  -H "Content-Type: application/json" \  -d '{    "entity": "agent",    "ids": [      "string"    ],    "object": "contact"  }'
{
  "billing": {
    "charged": 0,
    "note": "string"
  },
  "dryRun": true,
  "entity": "agent",
  "object": "contact",
  "portalId": "string",
  "portalRecorded": true,
  "results": [
    {
      "crmRecordId": "string",
      "id": "string",
      "message": "string",
      "preserved": [
        "string"
      ],
      "reason": "not_found",
      "status": "created"
    }
  ],
  "summary": {
    "created": 0,
    "failed": 0,
    "requested": 0,
    "skipped": 0,
    "updated": 0
  }
}
{
  "code": "string",
  "details": {
    "property1": null,
    "property2": null
  },
  "error": "string"
}
{
  "error": "string"
}
{
  "balance": 0,
  "cost": 0,
  "error": "string"
}
{
  "error": "string"
}
{
  "code": "string",
  "details": {
    "property1": null,
    "property2": null
  },
  "error": "string"
}
{
  "code": "string",
  "details": {
    "property1": null,
    "property2": null
  },
  "error": "string"
}

Check whether records can be sent to HubSpot GET

Reports whether your HubSpot account is connected, which record types your workspace has set up to send, and whether the connected account is the one that setup was built for. Read-only — call it before offering to send anything.

Count lenders matching filters POST

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