Create a matter
POST/legal/{connection_id}/matter
Parameters
fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection
Payload
idstring
created_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestring
numberstring
the firm's display/matter number
descriptionstring
status enum
Valid values:
"PENDING"
"OPEN"
"CLOSED"
"OTHER"
billing_method enum
Valid values:
"HOURLY"
"FLAT_FEE"
"CONTINGENCY"
"OTHER"
practicearea_idstring
pointer to the Legal Practicearea object
stagestring
the matter stage name
contact_idsstring array
CRM Contacts that are clients on this matter
company_idsstring array
CRM Companies that are clients on this matter
user_idstring
HR Employee who is the responsible attorney (reference to HrisEmployee)
originating_user_idstring
HR Employee who is the originating attorney (reference to HrisEmployee)
user_idsstring array
other HR Employees assigned to this matter
client_referencestring
the client's own reference number for this matter
currencystring
is_billableboolean
opened_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
closed_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
pending_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
statute_of_limitations_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
Returns
| Response field | Type | Required | Description |
|---|---|---|---|
id | string | No | |
created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
name | string | No | |
number | string | No | the firm's display/matter number |
description | string | No | |
status | enum | No | Values: PENDING, OPEN, CLOSED, OTHER |
billing_method | enum | No | Values: HOURLY, FLAT_FEE, CONTINGENCY, OTHER |
practicearea_id | string | No | pointer to the Legal Practicearea object |
stage | string | No | the matter stage name |
contact_ids | string[] | No | CRM Contacts that are clients on this matter |
company_ids | string[] | No | CRM Companies that are clients on this matter |
parties | LegalParty[] | No | all people and organizations related to this matter, with their role |
parties[].contact_id | string | No | pointer to a CRM Contact |
parties[].company_id | string | No | pointer to a CRM Company |
parties[].role | enum | No | Values: CLIENT, OPPOSING_PARTY, OPPOSING_COUNSEL, CO_COUNSEL, WITNESS, EXPERT, JUDGE, REFERRER, OTHER |
parties[].description | string | No | the vendor's free-text relationship description |
user_id | string | No | HR Employee who is the responsible attorney (reference to HrisEmployee) |
originating_user_id | string | No | HR Employee who is the originating attorney (reference to HrisEmployee) |
user_ids | string[] | No | other HR Employees assigned to this matter |
client_reference | string | No | the client's own reference number for this matter |
currency | string | No | |
is_billable | boolean | No | |
opened_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
closed_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
pending_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
statute_of_limitations_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
metadata | LegalMetadata[] | No | custom field values |
metadata[].id | string | No | |
metadata[].slug | string | No | |
metadata[].value | object | No | |
metadata[].namespace | string | No | |
metadata[].format | enum | No | Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL |
metadata[].extra_data | object | No |
Errors
Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).
{
"statusCode": 429,
"error": "Too Many Requests",
"message": "Too many requests to unified.to API; max requests per minute: N"
}| Status | Error | Meaning |
|---|---|---|
400 | Bad Request | The request was malformed or failed validation. |
401 | Unauthorized | The connection is likely broken; re-authorize it. |
403 | Forbidden | The connection is missing permissions or scopes. |
404 | Not Found | The requested resource does not exist. |
429 | Too Many Requests | Rate limit exceeded (see the two sources below). |
500 | Internal Server Error | An unexpected error occurred. |
501 | Not Implemented | Not supported by this integration. |
Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.
429 Too Many Requests
A 429 has two possible sources:
- The integration's own rate limit, passed through.
- Unified's workspace limit: a rolling 60 seconds, set by plan, with the message
Too many requests to unified.to API; max requests per minute: N.
const options = {
method: 'POST',
url: 'https://api.unified.to/legal/5de520f96e439b002043d8dc/matter',
headers: {
authorization: 'bearer .....'
},
data: undefined,
params: {
fields: '',
raw: '',
}
};
const results = await axios.request(options); Are we missing anything? Let us know