Create Matter (lawmatics_create-matter)
Create a matter (legal case) in Lawmatics. A new contact is created automatically from the provided contact fields; the matter starts in 'pnc' (potential new case) status.
Tool Input
caseTitlestring— Title of the matter/case
firstNamestring— First name for the matter's new contact
lastNamestring— Last name for the matter's new contact
emailstring(email)— Email address for the matter's new contact(pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$)
phonestring— Phone number for the matter's new contact
practiceAreaIdstring— ID of the practice area to assign; a numeric string (e.g. '986')(pattern: ^\d+$)
subStatusIdstring— ID of the sub-status to assign; a numeric string (e.g. '6')(pattern: ^\d+$)
notesarray— Notes to create inline with the matter (write-only; not returned)
[]object
namestringrequired— Note title
bodystringrequired— Note content
tagsarray— Tag names to attach to the matter; missing tags are created
[]string
customFieldsarray— Custom field values to set on the new matter; pass null as a value to clear
[]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 matter ID of the newly created matter
caseTitlestringnullrequired— Title of the matter/case; null if unset
caseBlurbstringnullrequired— Short description of the matter (read-only attribute); null if unset
statusstringrequired— Matter status (e.g. "pnc", "hired", "lost"); new matters start as "pnc"
subStatusstringnullrequired— Sub-status label within the status; null if unset
firstNamestringnullrequired— First name of the matter's primary contact; null if unset
lastNamestringnullrequired— Last name of the matter's primary contact; null if unset
emailstringnullrequired— Primary email address of the matter's contact; null if unset
phonestringnullrequired— Primary phone number of the matter's contact; null if unset
customFieldsarrayrequired— Account-defined custom fields on the matter; 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`
createdAtstringrequired— When the matter was created, as an ISO 8601 timestamp
updatedAtstringrequired— When the matter was last updated, as an ISO 8601 timestamp
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 'company' -> get-company, type 'user' -> get-user).
sourceobjectnullrequired— Lead source 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
stageobjectnullrequired— Pipeline stage 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
campaignobjectnullrequired— Marketing campaign 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
practiceAreaobjectnullrequired— Practice area 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
salespersonobjectnullrequired— Salesperson (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
leadAttorneyobjectnullrequired— Lead attorney (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
originatingAttorneyobjectnullrequired— Originating attorney (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
ownedByobjectnullrequired— Owning 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
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
contactobjectnullrequired— Primary contact 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
companyobjectnullrequired— Linked company 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
assignedStaffarrayrequired— Assigned staff (user) 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
eventsarrayrequired— Event 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
fileRequestsarrayrequired— File-request 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
documentsarrayrequired— Document 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
filesarrayrequired— File 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
foldersarrayrequired— Folder 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
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
tasksarrayrequired— Task 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
[]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
invoicesarrayrequired— Invoice 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
relationshipsarrayrequired— Related-party relationship-record 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