CRM

(Re)assign a record's working owner

patchapi.modelmatch.com/v1/crm/records

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Body application/json

entityIdstringrequired

entityTypeenumrequired

Options:loagentcompanybranch

grantAccessboolean

ownerUserIdstring | nullrequired

Responses

200objectThe record's owner after the call; `needsShare` is set instead when the assignee can't see the record and the write was held.

Show attributes

dataobjectrequired

Show child attributes

canShareboolean

needsShareboolean

ownerUserIdstringrequired

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 PATCH "https://api.modelmatch.com/v1/crm/records" \
  -H "x-api-key: $MODEL_MATCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "entityId": "<string>",
    "entityType": "lo",
    "ownerUserId": "<string>",
    "grantAccess": true
  }'

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

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

const { data, error } = await Crm.setCrmRecordOwner({
  body: {
    entityId: "<string>",
    entityType: "lo",
    ownerUserId: "<string>",
    grantAccess: true
  }
});

import os
import requests

res = requests.patch(
    "https://api.modelmatch.com/v1/crm/records",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
    json={
        "entityId": "<string>",
        "entityType": "lo",
        "ownerUserId": "<string>",
        "grantAccess": True
    },
)
data = res.json()

200 response

{
  "data": {
    "canShare": true,
    "needsShare": true,
    "ownerUserId": "<string>"
  }
}