Model MatchHelp

CRM

Find the records in a CRM list that have Market-Insights updates to review

postapi.modelmatch.com/v1/crm/lists/{id}/mi-updates

Checks a CRM list's members against current Market-Insights data and returns ONLY the records that need attention, each with its proposed updates. Use this instead of calling getCrmRecordProfile + getCrmMiUpdates for every member: one call covers a page of up to 50 members, and records the user already reviewed (applied or dismissed) with nothing new since are left out. Page with cursor until nextCursor is null; a page may return no records and still have more to scan. Act on the results with applyCrmListMiUpdates (explicit per-record accepted updates) and dismissCrmListMiUpdates (snooze the rest). Each scan counts as a check of those records, exactly like getCrmMiUpdates.

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Path parameters

idstringrequired

The CRM list id.

Body application/json

cursorstring

nextCursor of the previous page.

entityTypesenum[]

Only these entity types.

Options:loagentcompanybranch
includeSnoozedbooleandefault: false

Also return records whose proposals were all already reviewed.

limitintegerdefault: 25

Members evaluated per page (max 50), not records returned.

Responses

200objectThe records on this page that need Market-Insights review, with their proposed updates.
Show attributes
dataobjectrequired
Show child attributes
failedEntityIdsstring[]required

Members whose check failed transiently; retry them with getCrmMiUpdates or a later pass.

fieldSetVersionnumberrequired
nextCursorstring | nullrequired

Pass back as cursor for the next page; null once every member has been scanned. A page can return zero records and still have a nextCursor — keep paging until it is null.

recordsobject[]required
Show child attributes
checkedAtnumberrequired

Epoch ms of this check.

entityIdstringrequired
entityTypeenumrequired
Options:loagentcompanybranch
inputsChangedbooleanrequired

The Market-Insights data or the record changed since the previous check (true when the record had never been checked).

namestring | nullrequired
statusenumrequired

needs_review: at least one proposal the user has not reviewed. snoozed: every proposal was already reviewed within the check window (only returned with includeSnoozed: true).

Options:needs_reviewsnoozed
updatesobject[]required
scannednumberrequired

List members evaluated by this page.

summaryobjectrequired

Tally over every member this page scanned.

Show child attributes
failednumberrequired
needsReviewnumberrequired
snoozednumberrequired
unavailablenumberrequired

Members with no Market-Insights data to compare against (manual / unmatched records).

upToDatenumberrequired
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.