CRM

Compute which Market-Insights fields differ from a record snapshot

postapi.modelmatch.com/v1/crm/records/mi-updates

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Body application/json

entityIdstringrequired

entityTypeenumrequired

Options:loagentcompanybranch

Responses

200objectThe available per-field updates + the check timestamp (null when skipped).

Show attributes

dataobjectrequired

Show child attributes

checkedAtnumber | nullrequired

updatesobject[]required

Show child attributes

actionenumrequired

Options:addoverwrite

currentstring | nullrequired

fieldstringrequired

idstringrequired

incomingstringrequired

kindstring

labelstringrequired

linkageobject

seenKeystringrequired

storeenumrequired

Options:overridecontact

400objectValidation error

401objectUnauthorized

403objectForbidden (authenticated, but missing required context — e.g. no active organization)

404objectNot found

413objectResponse payload too large — detail endpoint capped to fit Lambda response limits

503objectSearch timed out or the cluster is overloaded — retry after `Retry-After` seconds.

curl -X POST "https://api.modelmatch.com/v1/crm/records/mi-updates" \
  -H "x-api-key: $MODEL_MATCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "entityId": "<string>",
    "entityType": "lo"
  }'

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

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

const { data, error } = await Crm.getCrmMiUpdates({
  body: {
    entityId: "<string>",
    entityType: "lo"
  }
});

import os
import requests

res = requests.post(
    "https://api.modelmatch.com/v1/crm/records/mi-updates",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
    json={
        "entityId": "<string>",
        "entityType": "lo"
    },
)
data = res.json()

200 response

{
  "data": {
    "checkedAt": 123.45,
    "updates": [
      {
        "action": "add",
        "current": "<string>",
        "field": "<string>",
        "id": "<string>",
        "incoming": "<string>",
        "kind": "<string>",
        "label": "<string>",
        "linkage": {
          "companyNmlsId": "<string>",
          "office": {
            "city": "<string>",
            "key": "<string>",
            "lat": 123.45,
            "lon": 123.45,
            "name": "<string>",
            "state": "<string>"
          }
        },
        "seenKey": "<string>",
        "store": "override"
      }
    ]
  }
}