CRM

Grant a member access to a list

postapi.modelmatch.com/v1/crm/lists/{id}/shares

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Path parameters

idstringrequired

Body application/json

permissionenum

Options:editorviewer

userIdstringrequired

Responses

200objectWhether a new grant was created.

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

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

curl -X POST "https://api.modelmatch.com/v1/crm/lists/<id>/shares" \
  -H "x-api-key: $MODEL_MATCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "userId": "<string>",
    "permission": "editor"
  }'

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

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

const { data, error } = await Crm.grantCrmListAccess({
  path: {
    id: "<id>"
  },
  body: {
    userId: "<string>",
    permission: "editor"
  }
});

import os
import requests

res = requests.post(
    "https://api.modelmatch.com/v1/crm/lists/<id>/shares",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
    json={
        "userId": "<string>",
        "permission": "editor"
    },
)
data = res.json()

200 response

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