CRM

Update an object-scoped custom field (label / options / config / order)

patchapi.modelmatch.com/v1/crm/fields

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Body application/json

configobject | null

Show child attributes

[key: string]null

idstringrequired

labelstring

optionsobject[] | null

Show child attributes

colorstring

idstringrequired

labelstringrequired

outcomeenum | null

Reporting classification (status fields only). Absent = in-progress. Seed ids won/lost classify by convention when absent; null explicitly un-classifies them (in-progress).

Options:wonlostnull

sortOrdernumber

Responses

200objectWhether a field was updated.

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/fields" \
  -H "x-api-key: $MODEL_MATCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "<string>",
    "label": "<string>",
    "sortOrder": 123.45
  }'

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

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

const { data, error } = await Crm.updateCrmObjectField({
  body: {
    id: "<string>",
    label: "<string>",
    sortOrder: 123.45
  }
});

import os
import requests

res = requests.patch(
    "https://api.modelmatch.com/v1/crm/fields",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
    json={
        "id": "<string>",
        "label": "<string>",
        "sortOrder": 123.45
    },
)
data = res.json()

200 response

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