CRM

Freshen a record's mirrored Market-Insights row on demand

postapi.modelmatch.com/v1/crm/records/refresh-mirror

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Body application/json

entityIdstringrequired

Responses

200objectWhether the mirror moved, and the display after the attempt. Never errors on a record that cannot be refreshed.

Show attributes

dataobjectrequired

Show child attributes

displayobjectrequired

The record's mirrored display after the attempt.

Show child attributes

branchNamestring

branchNmlsIdstring

cbsaCodestring

citystring

companyNamestring

companyNmlsIdstring

contactCheckedAtnumber

countystring

countyFipsstring

locationstring

namestringrequired

statestring

subtitlestring

unitsnumber

volumenumber

zipstring

refreshedbooleanrequired

Whether the mirrored row actually CHANGED. false when it was already current, when the record has no resolvable MM link, or when the refresh could not run — all of which are normal and none of which are errors.

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/refresh-mirror" \
  -H "x-api-key: $MODEL_MATCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "entityId": "<string>"
  }'

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

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

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

import os
import requests

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

200 response

{
  "data": {
    "display": {
      "branchName": "<string>",
      "branchNmlsId": "<string>",
      "cbsaCode": "<string>",
      "city": "<string>",
      "companyName": "<string>",
      "companyNmlsId": "<string>",
      "contactCheckedAt": 123.45,
      "county": "<string>",
      "countyFips": "<string>",
      "location": "<string>",
      "name": "<string>",
      "state": "<string>",
      "subtitle": "<string>",
      "units": 123.45,
      "volume": 123.45,
      "zip": "<string>"
    },
    "refreshed": true
  }
}