CRM

Create an object-scoped (workspace-wide) custom field

postapi.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

keystring

labelstringrequired

objectTypeenumrequired

Options:peoplecompanies

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

typeenumrequired

Options:textnumbercurrencydateselectmultiselecturlratingcheckboxstatustags

Responses

200objectThe created field.

Show attributes

dataobjectrequired

Show child attributes

configobject | nullrequired

Show child attributes

[key: string]null

idstringrequired

keystringrequired

labelstringrequired

listIdstring | nullrequired

objectTypeenumrequired

Options:peoplecompanies

optionsobject[] | nullrequired

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

scopeenumrequired

Options:objectlist

sortOrdernumberrequired

typeenumrequired

Options:textnumbercurrencydateselectmultiselecturlratingcheckboxstatustags

400objectValidation error

401objectUnauthorized

403objectForbidden (authenticated, but missing required context — e.g. no active organization)

404objectNot found

409objectA field with that key already exists for the object type.

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

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

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

const { data, error } = await Crm.createCrmObjectField({
  body: {
    label: "<string>",
    objectType: "people",
    type: "text",
    key: "<string>",
    sortOrder: 123.45
  }
});

import os
import requests

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

200 response

{
  "data": {
    "config": {
      "key": null
    },
    "id": "<string>",
    "key": "<string>",
    "label": "<string>",
    "listId": "<string>",
    "objectType": "people",
    "options": [
      {
        "color": "<string>",
        "id": "<string>",
        "label": "<string>",
        "outcome": "won"
      }
    ],
    "scope": "object",
    "sortOrder": 123.45,
    "type": "text"
  }
}