PUT
/
matters
/
{matterId}
Update a matter
curl --request PUT \
  --url https://api.smokeball.com/matters/{matterId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "externalSystemId": "EXT01",
  "number": "FUS-124",
  "matterTypeId": "009f778f-83df-454a-b344-768a862a7e55",
  "clientIds": [
    "832e778f-83df-454a-b344-768a862a7e67"
  ],
  "otherSideIds": [
    "776e778f-83df-454a-b344-768a862a6e58"
  ],
  "branchId": "dd4e4381-b6a0-4c64-8feb-e8ea8016ea42",
  "branchProviderId": "Smokeball",
  "clientRole": "Buyer",
  "otherSideRole": "Seller",
  "description": "This is a brief description for the matter",
  "status": "Open",
  "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",
  "referralAgreementFeeType": "<string>",
  "referralAgreementFee": 123,
  "referralAgreementFeeComment": "<string>",
  "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"
  ],
  "splitOriginatingStaffSettings": {
    "isEnabled": true,
    "splitMatterStaffs": [
      {
        "matterStaffId": "<string>",
        "matterStaffRatio": 123
      }
    ],
    "splitMethod": "<string>",
    "remainderStaffId": "<string>"
  },
  "supervisorStaffId": "c85d28cb-a760-4627-aa59-0a853c2e65ed",
  "clientCode": "Client A",
  "isLead": false
}'
{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET"
}

Authorizations

​
x-api-key
string
header
required
​
Authorization
string
header
required

Path Parameters

​
matterId
string<uuid>
required

Body

​
externalSystemId
string | null

External system id for the matter.

Example:

"EXT01"

​
number
string | null

Human-friendly number assigned to matter.

Example:

"FUS-124"

​
matterTypeId
string | null

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.

Example:

"009f778f-83df-454a-b344-768a862a7e55"

​
clientIds
string[] | null

List of 'Client' contact id's associated with the matter.

Example:
["832e778f-83df-454a-b344-768a862a7e67"]
​
otherSideIds
string[] | null

List of 'OtherSide' contact id's associated with the matter.

Example:
["776e778f-83df-454a-b344-768a862a6e58"]
​
branchId
string | null

Unique identifier of the associated branch.

Example:

"dd4e4381-b6a0-4c64-8feb-e8ea8016ea42"

​
branchProviderId
string | null

Unique identifier of the associated branch provider.

Example:

"Smokeball"

​
clientRole
string | null

'Client' matter type representative option for the matter.

If unsure, this can be left empty and the default Client role will be used.

Example:

"Buyer"

​
otherSideRole
string | null

'OtherSide' matter type representative option for the matter.

If unsure, this can be left empty and the default OtherSide role will be used.

Example:

"Seller"

​
description
string | null

Brief description of the matter.

Example:

"This is a brief description for the matter"

​
status
string | null

Current status of matter.

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

Example:

"Open"

​
openedDate
string<date-time> | null

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

Example:

"2022-04-23T14:00:00Z"

​
closedDate
string<date-time> | null

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

Example:

"2022-04-23T14:00:00Z"

​
leadOpenedDate
string<date-time> | null

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

Only applies if isLead is true.

Example:

"2022-04-23T14:00:00Z"

​
leadClosedDate
string<date-time> | null

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

Only applies if isLead is true.

Example:

"2022-04-23T14:00:00Z"

​
leadClosedReason
string | null

Reason the lead was closed.

Only applies if isLead is true.

Example:

"No longer interested"

​
referralType
string | null

Referral Type of the matter.

Custom Referral Types are also supported, the name or id of the Custom Referral Type can be used. If the name is used, it is looked up and stored as the id.

See the Referral Types API for retrieval of all valid Referral Types.

Possible values may also differ per region.

Example:

"Google"

​
referrerId
string | null

Contact id of the person that referred the matter.

Example:

"97bbe49f-6460-4bfc-b287-34ddfdbb81ef"

​
referralAgreementFeeType
string | null

The referral agreement fee type.

Possible values: %, Flat fee, Other

​
referralAgreementFee
number | null

The referral agreement fee value.

​
referralAgreementFeeComment
string | null

The referral agreement fee comment.

​
personResponsibleStaffId
string | null

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

Example:

"c85d28cb-a760-4627-aa59-0a853c2e65ed"

​
personAssistingStaffId
string | null

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

Example:

"c85d28cb-a760-4627-aa59-0a853c2e65ed"

​
personAssistingStaffIds
string[] | null

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

Example:
["c85d28cb-a760-4627-aa59-0a853c2e65ed"]
​
originatingStaffId
string | null

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

Example:

"c85d28cb-a760-4627-aa59-0a853c2e65ed"

​
originatingStaffIds
string[] | null

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

Required when SplitOriginatingStaffSettings is provided and enabled.

Example:
["c85d28cb-a760-4627-aa59-0a853c2e65ed"]
​
splitOriginatingStaffSettings
object

Settings for splitting originating staff members on a matter.

​
supervisorStaffId
string | null

Staff id of the supervisor of the matter.

Only supported in the UK.

Example:

"c85d28cb-a760-4627-aa59-0a853c2e65ed"

​
clientCode
string | null

Associates an external client code to this matter.

Only supported in AU and UK.

Example:

"Client A"

​
isLead
boolean

Optional boolean flag indicating if a 'Lead' is being created. This must be set to 'true' when creating a 'Lead'.

Example:

false

Response

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

​
id
string | null
​
href
string | null
​
relation
string | null
​
method
string | null
default:GET