CRM
Create a list-scoped custom field
postapi.modelmatch.com/v1/crm/lists/{listId}/fields
Authorization
Path parameters
listIdstringrequiredBody application/json
configobject | nullShow child attributesHide child attributes
[key: string]nullkeystringlabelstringrequiredobjectTypeenumOptions:
peoplecompaniesoptionsobject[] | nullShow child attributesHide child attributes
colorstringidstringrequiredlabelstringrequiredoutcomeenum | nullReporting classification (status fields only). Absent = in-progress. Seed ids won/lost classify by convention when absent; null explicitly un-classifies them (in-progress).
Options:
wonlostnullsortOrdernumbertypeenumrequiredOptions:
textnumbercurrencydateselectmultiselecturlratingcheckboxstatustagsResponses
200objectThe created custom field.Show attributesHide attributes
dataobjectrequiredShow child attributesHide child attributes
configobject | nullrequiredShow child attributesHide child attributes
[key: string]nullidstringrequiredkeystringrequiredlabelstringrequiredlistIdstring | nullrequiredobjectTypeenumrequiredOptions:
peoplecompaniesoptionsobject[] | nullrequiredShow child attributesHide child attributes
colorstringidstringrequiredlabelstringrequiredoutcomeenum | nullReporting classification (status fields only). Absent = in-progress. Seed ids won/lost classify by convention when absent; null explicitly un-classifies them (in-progress).
Options:
wonlostnullscopeenumrequiredOptions:
objectlistsortOrdernumberrequiredtypeenumrequiredOptions:
textnumbercurrencydateselectmultiselecturlratingcheckboxstatustags400objectValidation error401objectUnauthorized403objectForbidden (authenticated, but missing required context — e.g. no active organization)404objectNot found413objectResponse payload too large — detail endpoint capped to fit Lambda response limits503objectSearch timed out or the cluster is overloaded — retry after `Retry-After` seconds.