CRM

Add a contact method to a record

postapi.modelmatch.com/v1/crm/contacts

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Body application/json

entityIdstringrequired

isPrimaryboolean

kindenumrequired

Options:phoneemailsocialaddresswebsitefacebooklinkedinxzillowrealtoryoutubeinstagram

labelstring | null

mmKeystring | null

valuenull

Responses

200objectThe id of the newly added contact method.

Show attributes

dataobjectrequired

Show child attributes

idstringrequired

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/contacts" \
  -H "x-api-key: $MODEL_MATCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "entityId": "<string>",
    "kind": "phone",
    "isPrimary": true,
    "label": "<string>",
    "mmKey": "<string>",
    "value": null
  }'

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

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

const { data, error } = await Crm.addCrmContactMethod({
  body: {
    entityId: "<string>",
    kind: "phone",
    isPrimary: true,
    label: "<string>",
    mmKey: "<string>",
    value: null
  }
});

import os
import requests

res = requests.post(
    "https://api.modelmatch.com/v1/crm/contacts",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
    json={
        "entityId": "<string>",
        "kind": "phone",
        "isPrimary": True,
        "label": "<string>",
        "mmKey": "<string>",
        "value": None
    },
)
data = res.json()

200 response

{
  "data": {
    "id": "<string>"
  }
}