Create Address (lawmatics_create-address)
Create an address and attach it to a contact, matter, or company in Lawmatics. Provide the address label (e.g. Home, Work), the street, and the ID of exactly one entity (matter, contact, or company); city, state, and postal code are optional. Returns a `relationships` envelope of {id,type} pointers to the owning record (addressable) and any associated locations.
Tool Input
addressTypestringrequired— Address label (e.g. Home, Work, Mailing)
streetstringrequired— Street address line 1
street2string— Street address line 2 (apt, suite, etc.)
citystring— City
statestring— State or province
postalCodestring— Postal/ZIP code
countrystring— Country
matterIdstring— ID of the matter to attach this address to
contactIdstring— ID of the contact to attach this address to
companyIdstring— ID of the company to attach this address to
Tool Output
idstringrequired— Unique ID of the address
addressTypestringrequired— Address label (e.g. Home, Work, Mailing)
streetstringrequired— Street address line 1
street2stringnullrequired— Street address line 2 (apt, suite, etc.); null if unset
citystringnullrequired— City; null if unset
statestringnullrequired— State or province; null if unset
postalCodestringnullrequired— Postal/ZIP code; null if unset
countrystringnullrequired— Country; null if unset
fullAddressstringnullrequired— Full formatted single-line address; 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
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. an addressable of type 'contact' -> get-contact, type 'company' -> get-company).
addressableobjectnullrequired— Owning record pointer; null when unlinked. Polymorphic — the `type` is an open string (e.g. "contact", "company", "prospect" for a matter, "registerable_event", "firm"); resolve it by calling that record's own get/find tool
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
locationsarrayrequired— Office/location pointers this address is associated with; 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