CRM

Set a single override field on a record

patchapi.modelmatch.com/v1/crm/overrides

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Body application/json

entityIdstringrequired

entityTypeenumrequired

Options:loagentcompanybranch

fieldenumrequired

Options:statusnotestitlecompanycompanyTypefirstNamelastNamelocationcitystatezipcompanyNmlsIdoffice

valueone ofrequired

Show child attributes

Option 1string

Option 2object

Show child attributes

citystring

keystringrequired

latnumber

lonnumber

namestring

statestring

Responses

200objectThe record's updated overlay (+ re-derived location facets).

Show attributes

dataobjectrequired

Show child attributes

officeobject

Show child attributes

citystring

keystringrequired

latnumber

lonnumber

namestring

statestring

[key: string]string

derivedobject

Show child attributes

cbsaCodestring

countystring

countyFipsstring

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/overrides" \
  -H "x-api-key: $MODEL_MATCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "entityId": "<string>",
    "entityType": "lo",
    "field": "status",
    "value": "<string>"
  }'

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

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

const { data, error } = await Crm.setCrmOverride({
  body: {
    entityId: "<string>",
    entityType: "lo",
    field: "status",
    value: "<string>"
  }
});

import os
import requests

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

200 response

{
  "data": {
    "office": {
      "city": "<string>",
      "key": "<string>",
      "lat": 123.45,
      "lon": 123.45,
      "name": "<string>",
      "state": "<string>"
    }
  },
  "derived": {
    "cbsaCode": "<string>",
    "county": "<string>",
    "countyFips": "<string>"
  }
}