CRM

Set a record's value for one custom field

patchapi.modelmatch.com/v1/crm/custom-values

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Body application/json

entityIdstringrequired

fieldIdstringrequired

valueobjectrequired

Show child attributes

boolboolean | null

dateinteger | null

multistring[] | null

numnumber | null

textstring | null

Responses

200objectAcknowledgement that the value was written.

Show attributes

dataobjectrequired

Show child attributes

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/custom-values" \
  -H "x-api-key: $MODEL_MATCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "entityId": "<string>",
    "fieldId": "<string>",
    "value": {
      "bool": true,
      "date": 123,
      "num": 123.45
    }
  }'

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

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

const { data, error } = await Crm.setCrmCustomValue({
  body: {
    entityId: "<string>",
    fieldId: "<string>",
    value: {
      bool: true,
      date: 123,
      num: 123.45
    }
  }
});

import os
import requests

res = requests.patch(
    "https://api.modelmatch.com/v1/crm/custom-values",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
    json={
        "entityId": "<string>",
        "fieldId": "<string>",
        "value": {
            "bool": True,
            "date": 123,
            "num": 123.45
        }
    },
)
data = res.json()

200 response

{
  "data": {
    "updated": true
  }
}