Sign in

v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB
Matters

Patch a matter

Patches a specified matter.

Note: This endpoint can also be used to update a Lead, convert Lead to Matter and change the Lead/Matter type.

See Matters documentation for more details on how to use this.

The following actions are not supported:

  • items cannot be updated where either clientIds and/or otherSideIds are being updated

  • items cannot be updated when converting a Lead to Matter or changing the Lead/Matter type

  • clientRole cannot be updated, unless converting a Lead to Matter or changing the Lead/Matter type

  • Matter cannot be converted back to Lead

  • splitOriginatingStaffSettings cannot be updated without also providing originatingStaffIds in the same PATCH request

  • personAssistingStaffIds cannot contain personAssistingStaffId

  • originatingStaffIds cannot contain originatingStaffId

  • If split originating staff settings are enabled, originatingStaffIds and originatingStaffId cannot be updated

  • When updating via items, client role items and their sub-items must contain at least one item (cannot be empty), while non-client role items and their sub-items can be empty arrays to remove all items

patch/matters/{matterId}

Path parameters

matterIdstring uuid required

Request body

externalSystemIdstring nullable

External system id for the matter.

numberstring nullable

Human-friendly number assigned to matter.

matterTypeIdstring nullable

Unique identifier of the matter type associated with the matter.

Matter types define what information can be saved to the matter, relevant to that area of law and state / location.

A pre-configured list of matter types can be obtained via the 'GET /mattertypes' API.

'Lead' matter types are different from the standard matter types used when creating a 'Matter'.

Use the 'Type' query parameter in the 'GET /mattertypes' API call to get 'Lead' specific matter types.

descriptionstring nullable

Brief description of the matter.

statusstring nullable

Current status of matter.

Possible values: Open, Pending, Closed, Deleted or Cancelled.

dateOpenedstring date-time nullable

Date when the matter was opened. This can be backdated if required.

openedDatestring date-time nullable

Date the matter was opened. This can be backdated if required.

closedDatestring date-time nullable

Date the matter was closed. This can be backdated if required.

leadOpenedDatestring date-time nullable

Date the lead was opened. This can be backdated if required.

Only applies if isLead is true.

leadClosedDatestring date-time nullable

Date the lead was closed. This can be backdated if required.

Only applies if isLead is true.

leadClosedReasonstring nullable

Reason the lead was closed.

Only applies if isLead is true.

referralTypestring nullable

Referral Type of the matter.

Possible values are different per region.

referrerIdstring nullable

Contact id of the person that referred the matter.

referralAgreementFeeTypestring nullable

The referral agreement fee type.

Possible values: %, Flat fee, Other

referralAgreementFeenumber double nullable

The referral agreement fee value.

referralAgreementFeeCommentstring nullable

The referral agreement fee comment.

personResponsibleStaffIdstring nullable

Staff id of the person responsible for the matter (if applicable).

personAssistingStaffIdstring nullable

Staff id of the person assisting in the matter (if applicable).

personAssistingStaffIdsstring[] nullable

Staff ids of the other persons assisting in the matter (if applicable).

originatingStaffIdstring nullable

Staff id of the originating attorney (if in US) or an Introducer (if in AU)

originatingStaffIdsstring[] nullable

Staff ids of the other originating attorneys (if in US) or an Introducer (if in AU)

Required when SplitOriginatingStaffSettings is provided and enabled. This field must be included when updating SplitOriginatingStaffSettings.

supervisorStaffIdstring nullable

Staff id of the supervisor of the matter.

Only supported in the UK.

clientCodestring nullable

Associates an external client code to this matter.

Only supported in AU and UK.

branchIdstring nullable

Unique identifier of the associated branch.

branchProviderIdstring nullable

Unique identifier of the associated branch provider.

clientRolestring nullable

'Client' matter type representative option for the matter.

Required and only supported when converting a 'Lead' to 'Matter'.

isLeadboolean

Optional boolean flag indicating if matter is a 'Lead'.

This must be set to 'false' when converting a 'Lead' to 'Matter'.

clientIdsstring[] nullable

List of unique identifiers of 'Client' contacts associated with the matter.

otherSideIdsstring[] nullable

List of unique identifiers of 'OtherSide' contacts associated with the matter.

itemsobject nullable

Items associated with the matter.

Example request

{
  "externalSystemId": "EXT01",
  "number": "FUS-124",
  "matterTypeId": "009f778f-83df-454a-b344-768a862a7e55",
  "description": "This is a brief description for the matter",
  "status": "Open",
  "dateOpened": "2022-04-23T14:00:00Z",
  "openedDate": "2022-04-23T14:00:00Z",
  "closedDate": "2022-04-23T14:00:00Z",
  "leadOpenedDate": "2022-04-23T14:00:00Z",
  "leadClosedDate": "2022-04-23T14:00:00Z",
  "leadClosedReason": "No longer interested",
  "referralType": "Google",
  "referrerId": "97bbe49f-6460-4bfc-b287-34ddfdbb81ef",
  "personResponsibleStaffId": "c85d28cb-a760-4627-aa59-0a853c2e65ed",
  "personAssistingStaffId": "c85d28cb-a760-4627-aa59-0a853c2e65ed",
  "personAssistingStaffIds": [
    "c85d28cb-a760-4627-aa59-0a853c2e65ed"
  ],
  "originatingStaffId": "c85d28cb-a760-4627-aa59-0a853c2e65ed",
  "originatingStaffIds": [
    "c85d28cb-a760-4627-aa59-0a853c2e65ed"
  ],
  "supervisorStaffId": "c85d28cb-a760-4627-aa59-0a853c2e65ed",
  "clientCode": "Client A",
  "branchId": "c85d28cb-a760-4627-aa59-0a853c2e65ed",
  "branchProviderId": "c85d28cb-a760-4627-aa59-0a853c2e65ed",
  "clientRole": "Buyer"
}

Response

When request is accepted. Returns a hypermedia 'Link' object of the matter to be patched.

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable