Documentation
- Getting Started
- Authentication
- Making Requests
- Resource Creation
- Searching
- Plugins
- Webhooks
Tutorials
APIs
- Activity Codes
- Archive
- Authorization
- Bank Accounts
- Contacts
- Events
- Expenses
- Fees
- Files
- Firm
- Firm Users
- Folders
- Invoices
- Layout Designs
- Layout Matter Items
- Matter Billing Configuration
- Matter Items
- Matter Types
- Matters
- Memos
- Notifications
- Plugins
- Referral Types
- Relationships
- Roles
- Staff
- Stages
- Subscription Payments
- Subscription Promotions
- Subscriptions
- Tasks
- Users
- Webhooks
Matters
Update a matter
Updates a specified matter.
The following actions are currently not supported:
-
matterTypeId
cannot be modified, unless converting a lead to a matter -
clientIds
cannot be modified -
otherSideIds
cannot be modified -
Matter
cannot be converted back toLead
PUT
/
matters
/
{matterId}
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",
"originatingStaffId": "c85d28cb-a760-4627-aa59-0a853c2e65ed",
"supervisorStaffId": "c85d28cb-a760-4627-aa59-0a853c2e65ed",
"clientCode": "Client A",
"isLead": false
}'
{
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET"
}
Path Parameters
Body
Response
202
application/json
When request is accepted. Returns a hypermedia Link
object of the matter to be updated.
The response is of type object
.
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",
"originatingStaffId": "c85d28cb-a760-4627-aa59-0a853c2e65ed",
"supervisorStaffId": "c85d28cb-a760-4627-aa59-0a853c2e65ed",
"clientCode": "Client A",
"isLead": false
}'
{
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET"
}