CRM

Start caller-ID verification or re-check its outcome

postapi.modelmatch.com/v1/crm/caller-ids

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Body application/json

Option 1object

Show child attributes

actionenumrequired

Options:start

friendlyNamestring

phoneNumberstringrequired

Option 2object

Show child attributes

actionenumrequired

Options:check

idstringrequired

Responses

200objectThe caller-ID row (+ the verification code on start).

Show attributes

dataobjectrequired

Show child attributes

callerIdobjectrequired

Show child attributes

createdAtnumberrequired

friendlyNamestring | nullrequired

idstringrequired

isDefaultbooleanrequired

phoneNumberstringrequired

statusenumrequired

Options:pendingverifiedfailed

validationCodestring | null

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/caller-ids" \
  -H "x-api-key: $MODEL_MATCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "start",
    "phoneNumber": "<string>",
    "friendlyName": "<string>"
  }'

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

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

const { data, error } = await Crm.actionCrmCallerId({
  body: {
    action: "start",
    phoneNumber: "<string>",
    friendlyName: "<string>"
  }
});

import os
import requests

res = requests.post(
    "https://api.modelmatch.com/v1/crm/caller-ids",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
    json={
        "action": "start",
        "phoneNumber": "<string>",
        "friendlyName": "<string>"
    },
)
data = res.json()

200 response

{
  "data": {
    "callerId": {
      "createdAt": 123.45,
      "friendlyName": "<string>",
      "id": "<string>",
      "isDefault": true,
      "phoneNumber": "<string>",
      "status": "pending"
    },
    "validationCode": "<string>"
  }
}