CRM

Grant a user access to a record

postapi.modelmatch.com/v1/crm/record-shares

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Body application/json

entityIdstringrequired

listIdstring

sourceenum

Options:mentionmanual

userIdstringrequired

Responses

200objectWhether a new share was created (idempotent).

Show attributes

dataobjectrequired

Show child attributes

grantedbooleanrequired

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

502objectAuth service unavailable (roster needed for the gate).

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

curl -X POST "https://api.modelmatch.com/v1/crm/record-shares" \
  -H "x-api-key: $MODEL_MATCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "entityId": "<string>",
    "userId": "<string>",
    "source": "mention",
    "listId": "<string>"
  }'

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

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

const { data, error } = await Crm.grantCrmRecordAccess({
  body: {
    entityId: "<string>",
    userId: "<string>",
    source: "mention",
    listId: "<string>"
  }
});

import os
import requests

res = requests.post(
    "https://api.modelmatch.com/v1/crm/record-shares",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
    json={
        "entityId": "<string>",
        "userId": "<string>",
        "source": "mention",
        "listId": "<string>"
    },
)
data = res.json()

200 response

{
  "data": {
    "granted": true
  }
}