- Category: project management
- Auth: OAUTH2
- Composio-managed OAuth available? No
- Tools: 168
- Triggers: 0
- Slug:
SMOKEBALL - Version: 00000000_00
Tools
Add Matter File
Add Matter File
SMOKEBALL_ADD_MATTER_FILERegister a new matter file and return a sensitive presigned PUT URL valid for 1 hour that authorizes its content upload. Do not expose or log the URL. This toolkit does not upload bytes: PUT them with an empty Content-Type header, then allow the storage callback to complete. Confirm the file using the returned fileId with GET_MATTER_FILE; it returns 404 before confirmation. fileName is split on its last ’.’, normalized to XML-safe characters, and must retain a valid character. A 202 response means accepted, not completed.Input Parameters
Output
Add Matter Files Batch
Add Matter Files Batch
SMOKEBALL_ADD_MATTER_FILES_BATCHRegister a migration batch of matter files and return one sensitive presigned PUT URL, valid for 1 hour, per item in request order. Each URL authorizes content upload; do not expose or log it. The call is not atomic: validation proceeds in order, so a 400 for item n leaves earlier upload requests in place. There is no documented array cap or Location header. This toolkit does not upload bytes; PUT each file with an empty Content-Type header or it never exists. A 202 response means accepted, not completed. The provider’s root array is returned under data.Input Parameters
Output
Add Matter Layout
Add Matter Layout
SMOKEBALL_ADD_MATTER_LAYOUTAdds a layout item using a restricted documented subset. Layout key/value pairs are supported, but the provider’s untyped LayoutValue.state field is intentionally unavailable. A 202 result means accepted; read back the layout to confirm completion.Input Parameters
Output
Add Matter Layout Contact
Add Matter Layout Contact
SMOKEBALL_ADD_MATTER_LAYOUT_CONTACTAdds a new contact on a specified layout. A 202 result means accepted; read back the resource to confirm completion.Input Parameters
Output
Add Matter Role
Add Matter Role
SMOKEBALL_ADD_MATTER_ROLEAppends a new role in the specified matter. A 202 result means accepted; read back the resource to confirm completion.Input Parameters
Output
Add Matter Role Relationship
Add Matter Role Relationship
SMOKEBALL_ADD_MATTER_ROLE_RELATIONSHIPAppends a new relationship with an existing role in the specified matter. A 202 result means accepted; read back the resource to confirm completion.Input Parameters
Output
Create Activity Code
Create Activity Code
SMOKEBALL_CREATE_ACTIVITY_CODECreates an activity code. A 202 result means accepted; read back the resource to confirm completion.Input Parameters
Output
Create Bank Account Requisition
Create Bank Account Requisition
SMOKEBALL_CREATE_BANK_ACCOUNT_REQUISITIONSubmit an irreversible financial requisition against a trust account. If approvals are enabled, firm owners create it without approval and other users require approval; if approvals are disabled, creation automatically approves it. A 202 response means only that the request was accepted, not that processing completed; inspect the returned requisition status and balances to determine whether it is Pending or Approved.Input Parameters
Output
Create Bank Account Transaction
Create Bank Account Transaction
SMOKEBALL_CREATE_BANK_ACCOUNT_TRANSACTIONSubmit an irreversible financial Deposit transaction against the specified bank account and matter, with a dollar amount limited to 2 decimal places and an effective date. Deposit is the only documented transaction type. A 202 response means only that creation was accepted, not that the transaction completed; follow the returned link to confirm the resulting transaction.Input Parameters
Output
Create Contact
Create Contact
SMOKEBALL_CREATE_CONTACTCreates a contact. A 202 result means accepted; read back the resource to confirm completion.Input Parameters
Output
Create Contact Relation
Create Contact Relation
SMOKEBALL_CREATE_CONTACT_RELATIONCreates a relation for a specified contact. A 202 result means accepted; read back the resource to confirm completion.Input Parameters
Output
Create Event
Create Event
SMOKEBALL_CREATE_EVENTCreates a calendar event. Send startTime and endTime as local wall-clock time without an offset (YYYY-MM-DDThh:mm:ss) together with the IANA timeZone; an offset or Z is not applied. A 202 result means accepted; read back the event to confirm completion.Input Parameters
Output
Create Event Reminder
Create Event Reminder
SMOKEBALL_CREATE_EVENT_REMINDERCreates a new reminder for an event. A 202 result means accepted; read back the resource to confirm completion.Input Parameters
Output
Create File Preview
Create File Preview
SMOKEBALL_CREATE_FILE_PREVIEWGet or request a PDF preview of the current file version. The 202 response means accepted, not necessarily completed: if the preview already exists, downloadUrl is immediately populated with a sensitive presigned URL valid for 1 day; otherwise downloadUrl and expiry are null while asynchronous conversion runs. Do not expose or log a populated URL. Poll GET_FILE_VERSION_PREVIEW with documentVersionId until it returns 200. A new file version has a separate preview.Input Parameters
Output
Create Firm
Create Firm
SMOKEBALL_CREATE_FIRMCreates a firm for the current authenticated client and registers an existing user as a staff member and firm owner. A 202 result means accepted; read back the resource to confirm completion.Input Parameters
Output
Create Matter
Create Matter
SMOKEBALL_CREATE_MATTERCreates a new matter or Lead. Lead creation requires isLead=true, a Lead-specific matterTypeId, and a Grow or Prosper account. clientRole and otherSideRole are optional, cannot be identical, and otherwise default from the selected matter type. A 202 result means accepted; confirm completion with GET_MATTER on the returned id.Input Parameters
Output
Create Matter Expense
Create Matter Expense
SMOKEBALL_CREATE_MATTER_EXPENSECreates an expense for the specified matter. A 202 result means accepted; read back the resource to confirm completion.Input Parameters
Output
Create Matter Fee
Create Matter Fee
SMOKEBALL_CREATE_MATTER_FEECreates a fee for the specified matter. A 202 result means accepted; read back the resource to confirm completion.Input Parameters
Output
Create Matter Folder
Create Matter Folder
SMOKEBALL_CREATE_MATTER_FOLDERCreates a new folder under the specified matter. When parentFolderId is null or omitted the folder is created under the matter root. A 202 result means accepted; read back the resource to confirm completion.Input Parameters
Output
Create Matter Memo
Create Matter Memo
SMOKEBALL_CREATE_MATTER_MEMOCreates a memo on the specified matter. A 202 result means accepted; read back the resource to confirm completion.Input Parameters
Output
Create Notification
Create Notification
SMOKEBALL_CREATE_NOTIFICATIONSend a notification to the specified staff member, including its displayed message and optional toast message, icons, color, and Smokeball action URI. This is an externally visible, irreversible send. A 202 response means only that the request was accepted, not that delivery completed; use the returned link to read the resource and confirm completion.Input Parameters
Output
Create Staff Member
Create Staff Member
SMOKEBALL_CREATE_STAFF_MEMBERCreates a staff member in the firm associated with the authenticated client. A 202 result means accepted; read back the resource to confirm completion.Input Parameters
Output
Create Subtask
Create Subtask
SMOKEBALL_CREATE_SUBTASKCreates a subtask for a specified task. A 202 result means accepted; read back the resource to confirm completion.Input Parameters
Output
Create Task
Create Task
SMOKEBALL_CREATE_TASKCreates a task. A 202 result means accepted; read back the resource to confirm completion.Input Parameters
Output
Create Task Document
Create Task Document
SMOKEBALL_CREATE_TASK_DOCUMENTLinks an existing document to the specified task; it does not create a new document. A 202 result means accepted; read back the task’s documents to confirm completion.Input Parameters
Output
Create User
Create User
SMOKEBALL_CREATE_USERCreate a persistent user login using Default or Auth0. Invitation emails the user a way to set their password; Permanent and Temporary require the caller to deliver the password, and Temporary forces a change at first sign-in. bypassMfa lets the user sign in without two-factor authentication, while mfaEnrollmentGraceDays allows an Auth0 user to sign in without MFA enrollment for 1-90 days. Creating a login for an invited person registers them without accepting their invitation. This externally visible account and any MFA bypass are treated as irreversible effects.Input Parameters
Output
Create Webhook Subscription
Create Webhook Subscription
SMOKEBALL_CREATE_WEBHOOK_SUBSCRIPTIONCreate a persistent webhook subscription that sends every selected event type to the external eventNotificationUrl until the subscription is changed or deleted. The key is used to create the signature header on webhook notification requests and must be shared with the callback receiver. This enables ongoing external data egress and is treated as irreversible; verify the destination URL, event types, and signing key before use.Input Parameters
Output
Delete Activity Code
Delete Activity Code
Delete Contact
Delete Contact
Delete Contact Relation
Delete Contact Relation
Delete Event
Delete Event
Delete Event Reminder
Delete Event Reminder
Delete Firm User Mapping
Delete Firm User Mapping
Delete Matter
Delete Matter
Delete Matter Expense
Delete Matter Expense
Delete Matter Fee
Delete Matter Fee
Delete Matter File
Delete Matter File
Delete Matter Folder
Delete Matter Folder
SMOKEBALL_DELETE_MATTER_FOLDERDeletes a folder belonging to the specified matter. An unknown folder id returns 400 rather than 404, because the folder may have been created but not yet processed. The change is processed asynchronously; the returned Link continues to resolve the folder with isDeleted: true once applied. A 202 result means accepted; read back the resource to confirm completion.Input Parameters
Output
Delete Matter Memo
Delete Matter Memo
Delete Staff Member
Delete Staff Member
SMOKEBALL_DELETE_STAFF_MEMBERSets the staff member from the firm associated with the authenticated client as a former staff member. The staff member is set as a former staff member and if they are a user, becomes a former user. User access is also disabled. A 202 result means accepted; read back the resource to confirm completion.Input Parameters
Output
Delete Subtask
Delete Subtask
Delete Task
Delete Task
Delete Task Document
Delete Task Document
Delete Webhook Subscription
Delete Webhook Subscription
Get Activity Code
Get Activity Code
Get Bank Account
Get Bank Account
Get Bank Account Transaction
Get Bank Account Transaction
Get Contact
Get Contact
Get Contact Relation
Get Contact Relation
Get Contacts Batch
Get Contacts Batch
SMOKEBALL_GET_CONTACTS_BATCHReturn contacts matching up to 500 supplied IDs in request order; nonexistent and other-account IDs are silently omitted. Contact records are detailed, so requesting hundreds at once can produce a very large response and consume substantial model context or tokens; use smaller batches when full 500-contact retrieval is unnecessary.Input Parameters
ids in request order, with a maximum of 500 contact identifiers. Preserve provider field names and schema constraints.Output
Get Event
Get Event
Get File Download Url
Get File Download Url
SMOKEBALL_GET_FILE_DOWNLOAD_URLReturn a sensitive presigned GET URL and metadata for downloading the current or specified version of a matter file. The URL authorizes access to the file until it expires after 1 hour; do not expose or log it. This call does not fetch file bytes.Input Parameters
Output
Get File Preview
Get File Preview
SMOKEBALL_GET_FILE_PREVIEWReturn a sensitive presigned URL to the PDF preview of the file’s current version. The URL authorizes preview access for 1 day; do not expose or log it. This endpoint never creates a preview. Use CREATE_FILE_PREVIEW to request conversion; while conversion is pending, this endpoint returns 404 rather than a URL.Input Parameters
Output
Get File Version Preview
Get File Version Preview
SMOKEBALL_GET_FILE_VERSION_PREVIEWReturn a sensitive presigned URL to the PDF preview of a specific document version. The URL authorizes preview access for 1 day; do not expose or log it. If CREATE_FILE_PREVIEW requested an asynchronous conversion that is still pending, this endpoint returns 404; poll it until it returns 200.Input Parameters
Output
Get Firm
Get Firm
Get Firm User Mapping
Get Firm User Mapping
Get Layout Design
Get Layout Design
Get Matter
Get Matter
SMOKEBALL_GET_MATTERRetrieves one matter by id with its documented fields, including any item, role, layout, and tag details Smokeball returns for it. Use LIST_MATTERS to find the id. Smokeball does not document whether those nested details need the items/read, roles/read, or layouts/read scopes in addition to matters/read.Input Parameters
Output
Get Matter Archive
Get Matter Archive
Get Matter Billing Configuration
Get Matter Billing Configuration
Get Matter Expense
Get Matter Expense
Get Matter Fee
Get Matter Fee
Get Matter File
Get Matter File
Get Matter Folder Path
Get Matter Folder Path
Get Matter Invoice
Get Matter Invoice
Get Matter Invoice Download Url
Get Matter Invoice Download Url
SMOKEBALL_GET_MATTER_INVOICE_DOWNLOAD_URLReturn a sensitive download URL, its expiry timestamp, version, and status for the specified invoice. The URL authorizes access to invoice contents until the returned expiry; Smokeball does not document a fixed lifetime. Do not expose or log it. This call returns download details and does not fetch the invoice bytes.Input Parameters
Output
Get Matter Item
Get Matter Item
Get Matter Layout
Get Matter Layout
Get Matter Memo
Get Matter Memo
Get Matter Role
Get Matter Role
Get Matter Role Relationship
Get Matter Role Relationship
Get Matter Stage Info
Get Matter Stage Info
Get Matter Type
Get Matter Type
Get Notification
Get Notification
Get Protected Bank Account Balance
Get Protected Bank Account Balance
Get Referral Type
Get Referral Type
Get Staff Member
Get Staff Member
Get Stage Set
Get Stage Set
Get Stage Set Stage
Get Stage Set Stage
Get Subtask
Get Subtask
Get Task
Get Task
Get Task Document
Get Task Document
Get User
Get User
Get Webhook Subscription
Get Webhook Subscription
List Activity Codes
List Activity Codes
SMOKEBALL_LIST_ACTIVITY_CODESReturns a list of activity codes. Returns one page; pass next_cursor back as cursor to read the next one.Input Parameters
Output
List Bank Account Matter Balances
List Bank Account Matter Balances
SMOKEBALL_LIST_BANK_ACCOUNT_MATTER_BALANCESReturns a list of bank account matter balances. Returns one page; pass next_cursor back as cursor to read the next one.Input Parameters
Output
List Bank Accounts
List Bank Accounts
List Contact Relations
List Contact Relations
SMOKEBALL_LIST_CONTACT_RELATIONSReturn relations for a contact associated with the authenticated client. The provider returns a paged collection and navigation links, but documents no continuation request parameters for this endpoint; if the response indicates more results, this action cannot request another page and the list may be incomplete.Input Parameters
Output
List Contacts
List Contacts
SMOKEBALL_LIST_CONTACTSReturns a list of contacts. Returns one page; pass next_cursor back as cursor to read the next one.Input Parameters
Output
List Event Reminders
List Event Reminders
List Events
List Events
SMOKEBALL_LIST_EVENTSReturns a list of events. Returns one page; pass next_cursor back as cursor to read the next one.Input Parameters
Output
List File History
List File History
List Firm Matter Stage Mappings
List Firm Matter Stage Mappings
SMOKEBALL_LIST_FIRM_MATTER_STAGE_MAPPINGSReturns a list of stage to matter mappings in the firm. Returns one page; pass next_cursor back as cursor to read the next one.Input Parameters
Output
List Firm User Mappings
List Firm User Mappings
List Folder History
List Folder History
List Layout Designs
List Layout Designs
SMOKEBALL_LIST_LAYOUT_DESIGNSReturns a list of layout designs. Returns one page; pass next_cursor back as cursor to read the next one.Input Parameters
Output
List Matter Expenses
List Matter Expenses
SMOKEBALL_LIST_MATTER_EXPENSESReturns a list of expenses for the specified matter. Returns one page; pass next_cursor back as cursor to read the next one.Input Parameters
Output
List Matter Fees
List Matter Fees
SMOKEBALL_LIST_MATTER_FEESReturns a list of fees for the specified matter. Returns one page; pass next_cursor back as cursor to read the next one.Input Parameters
Output
List Matter Files
List Matter Files
SMOKEBALL_LIST_MATTER_FILESReturns a paged list of non-deleted files associated with a matter. In standard mode (no search or cursor), sort and paging apply; results default to oldest-created first. In search mode, results come from the document search index and sort, paging, and cursor all apply. In cursor-only mode (cursor without search), files modified since the cursor are returned and sort options are ignored. Returns one page; pass next_page_cursor back as page_cursor to read the next one (the provider’s own cursor parameter is separate). Limit defaults to the maximum page size.Input Parameters
Output
List Matter Folder Contents
List Matter Folder Contents
SMOKEBALL_LIST_MATTER_FOLDER_CONTENTSReturns non-deleted folders and files directly under a matter’s root document folder, or directly under folder_id when supplied, with folders before files. Paging spans the combined list; pass next_cursor back as cursor for the next page. A deleted requested folder still returns 200 with isDeleted=true and an empty listing, so an empty result alone does not distinguish a deleted folder from an active empty folder; inspect isDeleted.Input Parameters
Output
List Matter Invoices
List Matter Invoices
SMOKEBALL_LIST_MATTER_INVOICESReturns a list of invoices for the specified matter. Returns one page; pass next_cursor back as cursor to read the next one.Input Parameters
Output
List Matter Items
List Matter Items
List Matter Layout Contacts
List Matter Layout Contacts
List Matter Layouts
List Matter Layouts
List Matter Memos
List Matter Memos
SMOKEBALL_LIST_MATTER_MEMOSReturns a list of memos on the specified matter. Returns one page; pass next_cursor back as cursor to read the next one.Input Parameters
Output
List Matter Role Relationships
List Matter Role Relationships
List Matter Roles
List Matter Roles
List Matters
List Matters
SMOKEBALL_LIST_MATTERSReturns one page of matters; pass next_cursor back as cursor to read the next one. Supports documented filtering and sorting; the scope-sensitive Fields enrichment parameter is intentionally unavailable.Input Parameters
Output
List Matter Type Categories
List Matter Type Categories
List Matter Types
List Matter Types
SMOKEBALL_LIST_MATTER_TYPESReturns a paginated list of matter types based on search criteria. Deleted matter types are not included. Note: If no Location is provided, all matter types from all locations will be returned. Returns one page; pass next_cursor back as cursor to read the next one.Input Parameters
Output
List Referral Types
List Referral Types
List Staff
List Staff
SMOKEBALL_LIST_STAFFRetrieves a paginated list of staff members in the firm associated with the authenticated client. Returns one page; pass next_cursor back as cursor to read the next one.Input Parameters
Output
List Stage Sets
List Stage Sets
SMOKEBALL_LIST_STAGE_SETSReturns a list of stage sets for the firm. Returns one page; pass next_cursor back as cursor to read the next one.Input Parameters
Output
List Subtasks
List Subtasks
List Task Documents
List Task Documents
List Tasks
List Tasks
SMOKEBALL_LIST_TASKSReturns a list of tasks. Returns one page; pass next_cursor back as cursor to read the next one.Input Parameters
LastUpdated. This field will not be supported in future, please use LastUpdated instead.Output
List Webhook Event Types
List Webhook Event Types
List Webhook Subscriptions
List Webhook Subscriptions
SMOKEBALL_LIST_WEBHOOK_SUBSCRIPTIONSReturns existing webhook subscriptions. Returns one page; pass next_cursor back as cursor to read the next one.Input Parameters
Output
Merge Matter Layout
Merge Matter Layout
SMOKEBALL_MERGE_MATTER_LAYOUTMerges layout data using a restricted documented subset. Layout key/value pairs are supported, but the provider’s untyped LayoutValue.state field is intentionally unavailable. A 202 result means accepted; read back the layout to confirm completion.Input Parameters
Output
Patch Matter
Patch Matter
SMOKEBALL_PATCH_MATTERPatches a matter or Lead, including lead-to-matter conversion and matter-type changes. The recursive items property is intentionally unavailable. Documented field-combination restrictions still apply. A 202 result means accepted; confirm completion with GET_MATTER.Input Parameters
Output
Patch Matter Archive
Patch Matter Archive
SMOKEBALL_PATCH_MATTER_ARCHIVEUpdates the specified matter archive. The documented ArchiveDto requires isArchived in every request. A 202 result means accepted; read back the resource to confirm completion.Input Parameters
Output
Patch Matter Billing Configuration
Patch Matter Billing Configuration
SMOKEBALL_PATCH_MATTER_BILLING_CONFIGURATIONChanges only the supplied billing configuration fields for the specified matter. A 202 result means accepted; read back the resource to confirm completion.Input Parameters
Output
Patch Matter Expense
Patch Matter Expense
SMOKEBALL_PATCH_MATTER_EXPENSEChanges only the supplied expense fields for the specified matter. A 202 result means accepted; read back the resource to confirm completion. The documented queue accepts IDs without an existing-resource check; acceptance does not prove eventual completion.Input Parameters
Output
Patch Matter Fee
Patch Matter Fee
SMOKEBALL_PATCH_MATTER_FEEPatches a fee for the specified matter. The documented FeeDto requires feeDate and subject in every request. A 202 result means accepted; read back the resource to confirm completion. The documented queue accepts IDs without an existing-resource check; acceptance does not prove eventual completion.Input Parameters
Output
Patch Matter File
Patch Matter File
SMOKEBALL_PATCH_MATTER_FILEPartially updates a file’s metadata on the specified matter; only supplied fields change, but the documented schema still requires fileName. The response always includes a presigned PUT URL valid for 1 hour for an optional new version; this toolkit cannot upload bytes to it. Treat that URL as a sensitive temporary bearer capability and do not expose it in messages or logs. Only the documented object body is supported, not a JSON Patch array. A 202 result means accepted; read back the file to confirm completion.Input Parameters
Output
Patch Matter Folder
Patch Matter Folder
SMOKEBALL_PATCH_MATTER_FOLDERPartially updates a folder belonging to the specified matter. Only the fields supplied in the request are applied. A deleted folder can be restored by setting isDeleted to false. Only the folder itself is restored; subfolders and files that were deleted remain deleted. Other fields supplied in the same request are applied after the restore. A 202 result means accepted; read back the resource to confirm completion.Input Parameters
Output
Protect Bank Account Funds
Protect Bank Account Funds
SMOKEBALL_PROTECT_BANK_ACCOUNT_FUNDSProtects funds in a trust bank account. Only trust accounts are supported. A 202 result means accepted; read back the resource to confirm completion.Input Parameters
Output
Remove Contact Tag
Remove Contact Tag
Remove Matter Layout
Remove Matter Layout
Remove Matter Layout Contact
Remove Matter Layout Contact
Remove Matter Role
Remove Matter Role
SMOKEBALL_REMOVE_MATTER_ROLERemoves a specified role from a matter. A 202 result means accepted; read back the resource to confirm completion.Input Parameters
Output
Remove Matter Role Relationship
Remove Matter Role Relationship
SMOKEBALL_REMOVE_MATTER_ROLE_RELATIONSHIPRemoves a relationship from a role in a matter. A 202 result means accepted; read back the resource to confirm completion.Input Parameters
Output
Remove Matter Tag
Remove Matter Tag
SMOKEBALL_REMOVE_MATTER_TAGRemoves the tag from the matter without deleting from the account. A 202 result means accepted; read back the resource to confirm completion.Input Parameters
Output
Search Files
Search Files
SMOKEBALL_SEARCH_FILESSearch files across the account using a required full-text query and documented filters; return the documented result array. Return one page; use offset and limit to continue. The native root response is returned under data as an explicit Composio normalization.Input Parameters
Output
Unprotect Bank Account Funds
Unprotect Bank Account Funds
SMOKEBALL_UNPROTECT_BANK_ACCOUNT_FUNDSUnprotects funds in a trust bank account. Only trust accounts are supported. A 202 result means accepted; read back the resource to confirm completion.Input Parameters
Output
Update Activity Code
Update Activity Code
SMOKEBALL_UPDATE_ACTIVITY_CODEUpdates an activity code. A 202 result means accepted; read back the resource to confirm completion.Input Parameters
Output
Update Contact
Update Contact
SMOKEBALL_UPDATE_CONTACTUpdates a specified contact. Restore a deleted contact by setting isDeleted=false. A 202 result means accepted; read back the resource to confirm completion.Input Parameters
Output
Update Contact Relation
Update Contact Relation
SMOKEBALL_UPDATE_CONTACT_RELATIONUpdates a relation for a specified contact. A 202 result means accepted; read back the resource to confirm completion.Input Parameters
Output
Update Event
Update Event
SMOKEBALL_UPDATE_EVENTUpdates an event. Send startTime and endTime as local wall-clock time without an offset (YYYY-MM-DDThh:mm:ss) together with the IANA timeZone; an offset or Z is not applied. A 202 result means accepted; read back the event to confirm completion.Input Parameters
Output
Update Event Reminder
Update Event Reminder
SMOKEBALL_UPDATE_EVENT_REMINDERUpdates an existing reminder for an event. A 202 result means accepted; read back the resource to confirm completion.Input Parameters
Output
Update Firm
Update Firm
SMOKEBALL_UPDATE_FIRMUpdates firm details for the current authenticated client. A 202 result means accepted; read back the resource to confirm completion.Input Parameters
Output
Update Firm User Mapping
Update Firm User Mapping
SMOKEBALL_UPDATE_FIRM_USER_MAPPINGUpdates a user-to-staff mapping in the firm associated with the authenticated client. A 202 result means accepted; read back the resource to confirm completion.Input Parameters
Output
Update Matter
Update Matter
SMOKEBALL_UPDATE_MATTERUpdates a specified matter. clientIds and otherSideIds cannot be modified, and a Matter cannot be converted back to a Lead. A 202 result means accepted; confirm completion with GET_MATTER.Input Parameters
Output
Update Matter Archive
Update Matter Archive
SMOKEBALL_UPDATE_MATTER_ARCHIVEReplaces the specified matter archive by applying the full editable archive representation. A 202 result means accepted; read back the resource to confirm completion.Input Parameters
Output
Update Matter Billing Configuration
Update Matter Billing Configuration
SMOKEBALL_UPDATE_MATTER_BILLING_CONFIGURATIONReplaces the specified matter’s billing configuration by applying its full editable representation. A 202 result means accepted; read back the resource to confirm completion.Input Parameters
Output
Update Matter Expense
Update Matter Expense
SMOKEBALL_UPDATE_MATTER_EXPENSEReplaces the expense by applying its full editable representation for the specified matter. A 202 result means accepted; read back the resource to confirm completion. The documented queue accepts IDs without an existing-resource check; acceptance does not prove eventual completion.Input Parameters
Output
Update Matter Fee
Update Matter Fee
SMOKEBALL_UPDATE_MATTER_FEEReplaces the fee by applying its full editable representation for the specified matter. A 202 result means accepted; read back the resource to confirm completion. The documented queue accepts IDs without an existing-resource check; acceptance does not prove eventual completion.Input Parameters
Output
Update Matter File
Update Matter File
SMOKEBALL_UPDATE_MATTER_FILEReplace all editable file fields using PUT; use PATCH_MATTER_FILE for a partial edit. Omitting folderId or setting it to null moves the file to the root folder. Every call records a new upload request and returns a sensitive presigned PUT URL valid for 1 hour, which authorizes uploading an optional new version. Do not expose or log this URL. This toolkit does not upload bytes: PUT them to uploadUrl with an empty Content-Type header outside this toolkit. The 202 response means accepted, not that an upload or update completed.Input Parameters
Output
Update Matter Folder
Update Matter Folder
SMOKEBALL_UPDATE_MATTER_FOLDERReplaces the editable fields of a folder belonging to the specified matter. All fields are applied, not only the ones that changed: name is required, and omitting parentFolderId (or setting it to null) moves the folder to the matter root. Use PATCH to change individual fields. The destination folder must be on the same matter (400 otherwise); a destination that does not exist is not rejected. A 202 result means accepted; read back the resource to confirm completion. Null or omitted parentFolderId moves the folder to the matter root.Input Parameters
Output
Update Matter Memo
Update Matter Memo
SMOKEBALL_UPDATE_MATTER_MEMOUpdates a specified memo. A 202 result means accepted; read back the resource to confirm completion.Input Parameters
Output
Update Matter Role
Update Matter Role
SMOKEBALL_UPDATE_MATTER_ROLEUpdates a specified role on a matter. A 202 result means accepted; read back the resource to confirm completion.Input Parameters
Output
Update Matter Role Relationship
Update Matter Role Relationship
SMOKEBALL_UPDATE_MATTER_ROLE_RELATIONSHIPUpdates a specified relationship on a matter. A 202 result means accepted; read back the resource to confirm completion.Input Parameters
Output
Update Staff Member
Update Staff Member
SMOKEBALL_UPDATE_STAFF_MEMBERUpdates a staff member in the firm associated with the authenticated client. Setting former=true also deregisters the staff member from the firm. A 202 result means accepted; read back the resource to confirm completion.Input Parameters
Output
Update Subtask
Update Subtask
SMOKEBALL_UPDATE_SUBTASKUpdates a specified subtask of a specified task. A 202 result means accepted; read back the resource to confirm completion.Input Parameters
Output
Update Task
Update Task
SMOKEBALL_UPDATE_TASKUpdates a specified task. A 202 result means accepted; read back the resource to confirm completion.Input Parameters
Output
Update Webhook Subscription
Update Webhook Subscription
SMOKEBALL_UPDATE_WEBHOOK_SUBSCRIPTIONUpdate a persistent webhook subscription’s name, event types, external eventNotificationUrl, and signing key. Future selected events are sent to that callback URL until the subscription is changed or deleted; the key creates the signature header on notification requests. This changes ongoing external data egress and is treated as irreversible; verify the destination URL, event types, and key before use.