PATCH
/
matters
/
{matterId}
curl --request PATCH \
  --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",
  "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",
  "referralAgreementFeeType": "<string>",
  "referralAgreementFee": 123,
  "referralAgreementFeeComment": "<string>",
  "personResponsibleStaffId": "c85d28cb-a760-4627-aa59-0a853c2e65ed",
  "personAssistingStaffId": "c85d28cb-a760-4627-aa59-0a853c2e65ed",
  "originatingStaffId": "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",
  "isLead": false,
  "clientIds": [
    "<string>"
  ],
  "otherSideIds": [
    "<string>"
  ],
  "items": {}
}'
{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET"
}

Authorizations

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

Path Parameters

​
matterId
string
required

Body

Response

202
application/json

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

The response is of type object.