CRM

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

POST
/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-key<token>

In: header

Path Parameters

id*string

The CRM list id.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/crm/lists/string/mi-updates" \  -H "Content-Type: application/json" \  -d '{}'
{
  "data": {
    "failedEntityIds": [
      "string"
    ],
    "fieldSetVersion": 0,
    "nextCursor": "string",
    "records": [
      {
        "checkedAt": 0,
        "entityId": "string",
        "entityType": "lo",
        "inputsChanged": true,
        "name": "string",
        "status": "needs_review",
        "updates": [
          {
            "action": "add",
            "current": "string",
            "field": "string",
            "id": "string",
            "incoming": "string",
            "kind": "string",
            "label": "string",
            "linkage": {
              "companyNmlsId": "string",
              "office": {
                "city": "string",
                "key": "string",
                "lat": 0,
                "lon": 0,
                "name": "string",
                "state": "string"
              }
            },
            "previouslyReviewed": true,
            "seenKey": "string",
            "store": "override"
          }
        ]
      }
    ],
    "scanned": 0,
    "summary": {
      "failed": 0,
      "needsReview": 0,
      "snoozed": 0,
      "unavailable": 0,
      "upToDate": 0
    }
  }
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string",
  "limit": 0,
  "size": 0
}