CRM

Edit a note's body

patchapi.modelmatch.com/v1/crm/activity

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Body application/json

bodystringrequired

bodyHtmlstring | null

grantRecordAccessUserIdsstring[]

idstringrequired

listIdstring | null

recordNamestring

recordUrlstringdeprecated

Ignored — the record link is server-built.

Responses

200objectWhether the note was updated, plus its record + prior body.

Show attributes

dataobjectrequired

Show child attributes

entityIdstring | nullrequired

previousBodyHtmlstring | nullrequired

updatedbooleanrequired

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/activity" \
  -H "x-api-key: $MODEL_MATCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "body": "<string>",
    "id": "<string>",
    "bodyHtml": "<string>",
    "listId": "<string>",
    "recordName": "<string>",
    "recordUrl": "<string>"
  }'

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

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

const { data, error } = await Crm.editCrmNote({
  body: {
    body: "<string>",
    id: "<string>",
    bodyHtml: "<string>",
    listId: "<string>",
    recordName: "<string>",
    recordUrl: "<string>"
  }
});

import os
import requests

res = requests.patch(
    "https://api.modelmatch.com/v1/crm/activity",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
    json={
        "body": "<string>",
        "id": "<string>",
        "bodyHtml": "<string>",
        "listId": "<string>",
        "recordName": "<string>",
        "recordUrl": "<string>"
    },
)
data = res.json()

200 response

{
  "data": {
    "entityId": "<string>",
    "previousBodyHtml": "<string>",
    "updated": true
  }
}