CRM

Create (or refresh) a canonical record from a match

postapi.modelmatch.com/v1/crm/records

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Body application/json

displayobjectrequired

Show child attributes

branchNamestring

branchNmlsIdstring

cbsaCodestring

citystring

companyNamestring

companyNmlsIdstring

contactCheckedAtnumber

countystring

countyFipsstring

locationstring

namestringrequired

statestring

subtitlestring

unitsnumber

volumenumber

zipstring

entityIdstringrequired

entityTypeenumrequired

Options:loagentcompanybranch

linkobject | nullrequired

Show child attributes

entityIdstringrequired

mmaIdstring

nmlsIdstring

propertyIdstring

sourceenumrequired

Options:mmmanual

ownerUserIdstring

Responses

201objectWhether the record was newly created (vs. refreshed).

Show attributes

dataobjectrequired

Show child attributes

createdbooleanrequired

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" \
  -H "x-api-key: $MODEL_MATCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "display": {
      "name": "<string>",
      "branchName": "<string>",
      "branchNmlsId": "<string>",
      "cbsaCode": "<string>"
    },
    "entityId": "<string>",
    "entityType": "lo",
    "link": {
      "entityId": "<string>",
      "source": "mm",
      "mmaId": "<string>",
      "nmlsId": "<string>",
      "propertyId": "<string>"
    },
    "ownerUserId": "<string>"
  }'

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

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

const { data, error } = await Crm.createCrmRecord({
  body: {
    display: {
      name: "<string>",
      branchName: "<string>",
      branchNmlsId: "<string>",
      cbsaCode: "<string>"
    },
    entityId: "<string>",
    entityType: "lo",
    link: {
      entityId: "<string>",
      source: "mm",
      mmaId: "<string>",
      nmlsId: "<string>",
      propertyId: "<string>"
    },
    ownerUserId: "<string>"
  }
});

import os
import requests

res = requests.post(
    "https://api.modelmatch.com/v1/crm/records",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
    json={
        "display": {
            "name": "<string>",
            "branchName": "<string>",
            "branchNmlsId": "<string>",
            "cbsaCode": "<string>"
        },
        "entityId": "<string>",
        "entityType": "lo",
        "link": {
            "entityId": "<string>",
            "source": "mm",
            "mmaId": "<string>",
            "nmlsId": "<string>",
            "propertyId": "<string>"
        },
        "ownerUserId": "<string>"
    },
)
data = res.json()

201 response

{
  "data": {
    "created": true
  }
}