CRM

Apply the Market-Insights updates the user accepted

postapi.modelmatch.com/v1/crm/records/apply-mi-updates

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Body application/json

entityIdstringrequired

entityTypeenumrequired

Options:loagentcompanybranch

updatesone of[]required

Show child attributes

Option 1object

Show child attributes

fieldenumrequired

Options:titlecompanylocationcitystatezip

storeenumrequired

Options:override

valuestringrequired

Option 2object

Show child attributes

kindenumrequired

Options:emailphonelinkedinfacebookxinstagramyoutubezillowrealtorwebsite

storeenumrequired

Options:contact

valuestringrequired

Responses

200objectHow many accepted fields were persisted.

Show attributes

dataobjectrequired

Show child attributes

appliednumberrequired

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/apply-mi-updates" \
  -H "x-api-key: $MODEL_MATCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "entityId": "<string>",
    "entityType": "lo",
    "updates": [
      {
        "field": "title",
        "store": "override",
        "value": "<string>"
      }
    ]
  }'

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

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

const { data, error } = await Crm.applyCrmMiUpdates({
  body: {
    entityId: "<string>",
    entityType: "lo",
    updates: [
      {
        field: "title",
        store: "override",
        value: "<string>"
      }
    ]
  }
});

import os
import requests

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

200 response

{
  "data": {
    "applied": 123.45
  }
}