CRM

Apply a match to an imported record (link + seed contacts)

postapi.modelmatch.com/v1/crm/enrich/apply

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Body application/json

contactsobject[]

Show child attributes

isPrimaryboolean

kindenumrequired

Options:phoneemailsocialaddresswebsitefacebooklinkedinxzillowrealtoryoutubeinstagram

labelstring | null

valuenull

displayobject

Show child attributes

branchNamestring

branchNmlsIdstring

cbsaCodestring

citystring

companyNamestring

companyNmlsIdstring

contactCheckedAtnumber

countystring

countyFipsstring

locationstring

namestringrequired

statestring

subtitlestring

unitsnumber

volumenumber

zipstring

entityIdstringrequired

entityTypeenumrequired

Options:loagentcompanybranch

linkobject

Set to accept the match; omit to leave unlinked.

Show child attributes

entityIdstringrequired

mmaIdstring

nmlsIdstring

propertyIdstring

sourceenumrequired

Options:mmmanual

overrideSourcesobject

Origin of each overrides value: "mm" (ours) or "imported" (the customer's). An "mm" value the record already renders from the mirror is NOT pinned, so the record keeps tracking. Omit to pin everything.

Show child attributes

companystring

companyTypestring

titlestring

overridesobject

Show child attributes

companystring

companyTypestring

titlestring

Responses

200objectWhether a match was linked + the count of seeded contacts.

Show attributes

dataobjectrequired

Show child attributes

linkedbooleanrequired

seedednumberrequired

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/enrich/apply" \
  -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.applyCrmEnrichment({
  body: {
    entityId: "<string>",
    entityType: "lo"
  }
});

import os
import requests

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

200 response

{
  "data": {
    "linked": true,
    "seeded": 123.45
  }
}