CRM

Link a record to a chosen candidate

patchapi.modelmatch.com/v1/crm/match

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Body application/json

displayobject

Show child attributes

branchNamestring

branchNmlsIdstring

cbsaCodestring

citystring

companyNamestring

companyNmlsIdstring

contactCheckedAtnumber

countystring

countyFipsstring

locationstring

namestringrequired

statestring

subtitlestring

unitsnumber

volumenumber

zipstring

entityIdstringrequired

linkobject | nullrequired

Show child attributes

entityIdstringrequired

mmaIdstring

nmlsIdstring

propertyIdstring

sourceenumrequired

Options:mmmanual

Responses

200objectWhether the record was linked.

Show attributes

dataobjectrequired

Show child attributes

linkedbooleanrequired

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 PATCH "https://api.modelmatch.com/v1/crm/match" \
  -H "x-api-key: $MODEL_MATCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "entityId": "<string>",
    "link": {
      "entityId": "<string>",
      "source": "mm",
      "mmaId": "<string>",
      "nmlsId": "<string>",
      "propertyId": "<string>"
    }
  }'

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

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

const { data, error } = await Crm.linkCrmRecord({
  body: {
    entityId: "<string>",
    link: {
      entityId: "<string>",
      source: "mm",
      mmaId: "<string>",
      nmlsId: "<string>",
      propertyId: "<string>"
    }
  }
});

import os
import requests

res = requests.patch(
    "https://api.modelmatch.com/v1/crm/match",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
    json={
        "entityId": "<string>",
        "link": {
            "entityId": "<string>",
            "source": "mm",
            "mmaId": "<string>",
            "nmlsId": "<string>",
            "propertyId": "<string>"
        }
    },
)
data = res.json()

200 response

{
  "data": {
    "linked": true
  }
}