Update Company (lawmatics_update-company)
Update an existing company in Lawmatics by ID. The echo includes a `relationships` envelope of {id,type} pointers to related records (primary contact, contacts, prospects, tags, emails, phone numbers, addresses, notes, and the creating user).
Tool Input
companyIdstringrequired— ID of the company to update; a numeric string(pattern: ^\d+$)
namestring— Company name
emailstring(email)— Primary email address(pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$)
phoneNumberstring— Primary phone number
streetstring— Primary address street
street2string— Primary address street line 2
citystring— Primary address city
statestring— Primary address state / province
countrystring— Primary address country
postalCodestring— Primary address ZIP / postal code
emailsAttributesarray— Additional email addresses to create inline (write-only; not returned)
[]object
infostringrequired— The email address or phone number
labelstring— Label for this entry (e.g. Home, Work)
phoneNumbersAttributesarray— Additional phone numbers to create inline (write-only; not returned)
[]object
infostringrequired— The email address or phone number
labelstring— Label for this entry (e.g. Home, Work)
addressesAttributesarray— Additional addresses to create inline (write-only; returned via `addresses`)
[]object
streetstringrequired— Street address
street2string— Street address line 2
citystringrequired— City
statestringrequired— State / province
countrystringrequired— Country
postalCodestringrequired— ZIP / postal code
labelstring— Label for this address (e.g. Home, Work)
customFieldsarray— Custom field values to set; pass null as a value to clear that field
[]object
idstringnumberrequired— Custom field ID (the API returns it as a number; either a string or number is accepted)
valuestringnumberbooleannullrequired— Value to set (matches the field's type); pass null to clear the field
Tool Output
idstringrequired— Lawmatics company ID
namestringnullrequired— Company name; null if unset
emailstringnullrequired— Primary email address; null if unset
addressstringnullrequired— Computed, formatted full address string; read-only; null if unset
citystringnullrequired— Primary address city; null if unset
statestringnullrequired— Primary address state/province; null if unset
postalCodestringnullrequired— Primary address ZIP/postal code; null if unset
countrystringnullrequired— Primary address country; null if unset
phoneNumberstringnullrequired— Primary phone number as stored; null if unset
addressesarrayrequired— All addresses associated with the company; empty array if none
[]object
idnumberrequired— Address ID
streetstringnullrequired— Street address line 1; null if unset
street2stringnullrequired— Street address line 2; null if unset
citystringnullrequired— Address city; null if unset
statestringnullrequired— Address state/province; null if unset
postalCodestringnullrequired— Address ZIP/postal code; null if unset
countrystringnullrequired— Address country; null if unset
labelstringnullrequired— Address label (e.g. Primary, Home, Work); null if unset
createdAtstringnullrequired— When the address was created, as an ISO 8601 timestamp; null if unknown
updatedAtstringnullrequired— When the address was last updated, as an ISO 8601 timestamp; null if unknown
customFieldsarrayrequired— Account-defined custom fields on the company; empty array if none
[]object
idstringrequired— Custom field definition ID, as a numeric string
namestringnullrequired— Custom field display name; null if unset
fieldTypestringnullrequired— Custom field data type (e.g. text, date, select); null if unset
valueanyrequired— Raw custom field value; type varies by `fieldType`
formattedValueanyrequired— Display-formatted custom field value; type varies by `fieldType`
createdAtstringnullrequired— When the company was created, as an ISO 8601 timestamp; null if unknown
updatedAtstringnullrequired— When the company was last updated, as an ISO 8601 timestamp; null if unknown
relationshipsobjectrequired— JSON:API relationship pointers to related records as {id,type} stubs. Not materialized — follow a pointer by calling that resource's own get/find tool (e.g. type 'contact' -> get-contact, type 'user' -> get-user, type 'address' -> get-address).
primaryContactobjectnullrequired— Primary-contact pointer (live `type` "primary_contact"); null when unset
idstringrequired— ID of the referenced Lawmatics record
typestringrequired— JSON:API record class of the reference (e.g. "user", "contact", "prospect", "firm"); resolve it by calling that resource's own get/find tool — this pointer is not materialized
createdByobjectnullrequired— Creating user pointer; null when unset
idstringrequired— ID of the referenced Lawmatics record
typestringrequired— JSON:API record class of the reference (e.g. "user", "contact", "prospect", "firm"); resolve it by calling that resource's own get/find tool — this pointer is not materialized
contactsarrayrequired— Contact pointers; empty if none
[]object
2 fields
idstringrequired— ID of the referenced Lawmatics record
typestringrequired— JSON:API record class of the reference; resolve it by calling that resource's own tool
prospectsarrayrequired— Prospect (matter) pointers; empty if none
[]object
2 fields
idstringrequired— ID of the referenced Lawmatics record
typestringrequired— JSON:API record class of the reference; resolve it by calling that resource's own tool
tagsarrayrequired— Tag pointers; empty if none
[]object
2 fields
idstringrequired— ID of the referenced Lawmatics record
typestringrequired— JSON:API record class of the reference; resolve it by calling that resource's own tool
emailsarrayrequired— Email-address pointers; empty if none
[]object
2 fields
idstringrequired— ID of the referenced Lawmatics record
typestringrequired— JSON:API record class of the reference; resolve it by calling that resource's own tool
phoneNumbersarrayrequired— Phone-number pointers; empty if none
[]object
2 fields
idstringrequired— ID of the referenced Lawmatics record
typestringrequired— JSON:API record class of the reference; resolve it by calling that resource's own tool
addressesarrayrequired— Address pointers; empty if none. Distinct from the `addresses` attribute above, which carries the full nested address objects
[]object
2 fields
idstringrequired— ID of the referenced Lawmatics record
typestringrequired— JSON:API record class of the reference; resolve it by calling that resource's own tool
notesarrayrequired— Note pointers; empty if none
[]object
2 fields
idstringrequired— ID of the referenced Lawmatics record
typestringrequired— JSON:API record class of the reference; resolve it by calling that resource's own tool
Related Tools