CRM

Add a record to the CRM (and optionally a list)

postapi.modelmatch.com/v1/crm/records/add

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

grantRecordAccessUserIdsstring[]

linkobject | nullrequired

Show child attributes

entityIdstringrequired

mmaIdstring

nmlsIdstring

propertyIdstring

sourceenumrequired

Options:mmmanual

listIdstring

noteobject

Show child attributes

bodystringrequired

bodyHtmlstring | null

ownerUserIdstring

statusstring

Responses

200objectWhether the record was newly added + the member row.

Show attributes

dataobjectrequired

Show child attributes

addedbooleanrequired

memberobject | nullrequired

Show child attributes

addedAtnumberrequired

displayobjectrequired

entityIdstringrequired

entityTypeenumrequired

Options:loagentcompanybranch

lastActivityAtnumber | null

overridesobject

ownerUserIdstring | null

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/add" \
  -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>"
    },
    "listId": "<string>",
    "ownerUserId": "<string>",
    "status": "<string>"
  }'

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

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

const { data, error } = await Crm.addCrmRecord({
  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>"
    },
    listId: "<string>",
    ownerUserId: "<string>",
    status: "<string>"
  }
});

import os
import requests

res = requests.post(
    "https://api.modelmatch.com/v1/crm/records/add",
    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>"
        },
        "listId": "<string>",
        "ownerUserId": "<string>",
        "status": "<string>"
    },
)
data = res.json()

200 response

{
  "data": {
    "added": true,
    "member": {
      "addedAt": 123.45,
      "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>"
      },
      "entityId": "<string>",
      "entityType": "lo",
      "lastActivityAt": 123.45,
      "overrides": {
        "office": {
          "city": "<string>",
          "key": "<string>",
          "lat": 123.45,
          "lon": 123.45,
          "name": "<string>",
          "state": "<string>"
        }
      },
      "ownerUserId": "<string>"
    }
  }
}