CRM

Ask a record's owner to share it (membership-gated, notify-only)

postapi.modelmatch.com/v1/crm/records/request-access

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Body application/json

entityIdstringrequired

organizationIdstringrequired

Responses

200objectThe owner was emailed, a recent request still stands, or the caller already has access.

Show attributes

dataobjectrequired

Show child attributes

ownerNamestring | nullrequired

statusenumrequired

Options:requestedalready_requestedalready_has_access

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

422objectThe record has no owner/admin to notify.

502objectOwner-roster lookup or email send failed — safe to retry.

503objectSearch timed out or the cluster is overloaded — retry after `Retry-After` seconds.

curl -X POST "https://api.modelmatch.com/v1/crm/records/request-access" \
  -H "x-api-key: $MODEL_MATCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "entityId": "<string>",
    "organizationId": "<string>"
  }'

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

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

const { data, error } = await Crm.requestCrmRecordAccess({
  body: {
    entityId: "<string>",
    organizationId: "<string>"
  }
});

import os
import requests

res = requests.post(
    "https://api.modelmatch.com/v1/crm/records/request-access",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
    json={
        "entityId": "<string>",
        "organizationId": "<string>"
    },
)
data = res.json()

200 response

{
  "data": {
    "ownerName": "<string>",
    "status": "requested"
  }
}