--- title: "Patch a matter" method: PATCH path: "/matters/{matterId}" tags: ["Matters"] --- # Patch a matter `PATCH /matters/{matterId}` 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 ## Path parameters - `matterId` string, uuid, required ## Request body - MatterDto2 - `externalSystemId` string, nullable — External system id for the matter. - `number` string, nullable — Human-friendly number assigned to matter. - `matterTypeId` string, 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. - `description` string, nullable — Brief description of the matter. - `status` string, nullable — Current status of matter. Possible values: Open, Pending, Closed, Deleted or Cancelled. - `dateOpened` string, date-time, nullable — Date when the matter was opened. This can be backdated if required. - `openedDate` string, date-time, nullable — Date the matter was opened. This can be backdated if required. - `closedDate` string, date-time, nullable — Date the matter was closed. This can be backdated if required. - `leadOpenedDate` string, date-time, nullable — Date the lead was opened. This can be backdated if required. Only applies if isLead is true. - `leadClosedDate` string, date-time, nullable — Date the lead was closed. This can be backdated if required. Only applies if isLead is true. - `leadClosedReason` string, nullable — Reason the lead was closed. Only applies if isLead is true. - `referralType` string, nullable — Referral Type of the matter. Possible values are different per region. - `referrerId` string, nullable — Contact id of the person that referred the matter. - `referralAgreementFeeType` string, nullable — The referral agreement fee type. Possible values: %, Flat fee, Other - `referralAgreementFee` number, double, nullable — The referral agreement fee value. - `referralAgreementFeeComment` string, nullable — The referral agreement fee comment. - `personResponsibleStaffId` string, nullable — Staff id of the person responsible for the matter (if applicable). - `personAssistingStaffId` string, nullable — Staff id of the person assisting in the matter (if applicable). - `personAssistingStaffIds` string[], nullable — Staff ids of the other persons assisting in the matter (if applicable). - `originatingStaffId` string, nullable — Staff id of the originating attorney (if in US) or an Introducer (if in AU) - `originatingStaffIds` string[], 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. - `splitOriginatingStaffSettings` SplitMatterStaffSettingsDto - `isEnabled` boolean — Indicates whether the split matter staff settings are enabled or not. - `splitMatterStaffs` SplitMatterStaffDto[], nullable — List of staff members involved in the split matter settings. - `matterStaffId` string, nullable — The unique identifier for the split matter staff. - `matterStaffRatio` integer — The split ratio for the matter staff. - `splitMethod` string, nullable — Method used to split the matter staff. Possible values: Unknown, SplitEvenly, UseRatio. - `remainderStaffId` string, nullable — The unique identifier for the staff member who will handle the remainder of the matter after the split. - `supervisorStaffId` string, nullable — Staff id of the supervisor of the matter. Only supported in the UK. - `clientCode` string, nullable — Associates an external client code to this matter. Only supported in AU and UK. - `branchId` string, nullable — Unique identifier of the associated branch. - `branchProviderId` string, nullable — Unique identifier of the associated branch provider. - `clientRole` string, nullable — 'Client' matter type representative option for the matter. Required and only supported when converting a 'Lead' to 'Matter'. - `isLead` boolean — Optional boolean flag indicating if matter is a 'Lead'. This must be set to 'false' when converting a 'Lead' to 'Matter'. - `clientIds` string[], nullable — List of unique identifiers of 'Client' contacts associated with the matter. - `otherSideIds` string[], nullable — List of unique identifiers of 'OtherSide' contacts associated with the matter. - `items` object, nullable — Items associated with the matter. ## Response `202` When request is accepted. Returns a hypermedia 'Link' object of the matter to be patched. - Link - `id` string, nullable - `href` string, nullable - `relation` string, nullable - `method` string, nullable ## Other responses - `400` — When an unsupported request is made. - `403` — When the authenticated account does not have access to the matter. - `404` — When matter with specified id does not exist. --- [API](https://skmtc.net/smokeball/apis/api.md) · [All operations](https://skmtc.net/smokeball/apis/api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/smokeball/api/revisions/197984da9b42/schema)