Skip to main content
Smokeball logo
  • Category: project management
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 168
  • Triggers: 0
  • Slug: SMOKEBALL
  • Version: 00000000_00

Tools

Slug: SMOKEBALL_ADD_CONTACT_TAGSAdds one or more tags to an existing contact by contact id; tags that already exist on the contact are not duplicated by the documented behaviour. Returns a link to the contact; read it back with GET_CONTACT to see the full tag list.

Input Parameters

array
The list of tags to add
string
required
The contact ID
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
The file to add.
string
required
Unique identifier (GUID) of the matter.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
The files to add.
string
required
Unique identifier (GUID) of the matter.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Layout matter item to add, without untyped value state.
string
required
Matter identifier.
string
Optional correlation header for the asynchronous write and webhook callback.
boolean
Whether to skip field validation when adding the layout.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Structured JSON request body for add a contact to a layout. Preserve provider field names and schema constraints.
string
required
Identifier of the layout item to which the contact is added.
string
required
Identifier of the matter addressed by this operation.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Structured JSON request body for add role to a matter. Preserve provider field names and schema constraints.
integer
Provider version header; supported values and purpose are not documented in this operation. Omit unless Smokeball instructs you to send it.
string
required
Identifier of the matter addressed by this operation.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Structured JSON request body for add relationship to a role. Preserve provider field names and schema constraints.
string
required
Identifier of the role addressed by this operation.
integer
Provider version header; supported values and purpose are not documented in this operation. Omit unless Smokeball instructs you to send it.
string
required
Identifier of the matter addressed by this operation.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_ADD_MATTER_TAGSAdds one or more tags to an existing matter by matter id. Returns a link to the matter; read it back with GET_MATTER to see the full tag list.

Input Parameters

array
Structured JSON request body for add tags to a matter. Preserve provider field names and schema constraints.
string
required
Identifier of the matter addressed by this operation.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_CREATE_ACTIVITY_CODECreates an activity code. A 202 result means accepted; read back the resource to confirm completion.

Input Parameters

object
Structured JSON request body for create an activity code. Preserve provider field names and schema constraints.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_CREATE_AUTHORIZATION_GROUPCreates an authorization group. A 202 result means accepted; read back the resource to confirm completion.

Input Parameters

object
Structured JSON request body for create an authorization group. Preserve provider field names and schema constraints.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_CREATE_AUTHORIZATION_POLICYCreates an authorization policy. A 202 result means accepted; read back the resource to confirm completion.

Input Parameters

object
Structured JSON request body for create an authorization policy. Preserve provider field names and schema constraints.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Structured JSON request body for create a requisition. Preserve provider field names and schema constraints.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.
string
required
Identifier of the bank account addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Structured JSON request body for create a transaction. Preserve provider field names and schema constraints.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.
string
required
Identifier of the bank account addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_CREATE_CONTACTCreates a contact. A 202 result means accepted; read back the resource to confirm completion.

Input Parameters

object
Structured JSON request body for create a contact. Preserve provider field names and schema constraints.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_CREATE_CONTACT_RELATIONCreates a relation for a specified contact. A 202 result means accepted; read back the resource to confirm completion.

Input Parameters

object
Structured JSON request body for create a contact relation. Preserve provider field names and schema constraints.
string
required
Identifier of the contact addressed by this operation.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Structured JSON request body for create event. Preserve provider field names and schema constraints.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_CREATE_EVENT_REMINDERCreates a new reminder for an event. A 202 result means accepted; read back the resource to confirm completion.

Input Parameters

object
Structured JSON request body for create reminder for an event. Preserve provider field names and schema constraints.
string
required
Identifier of the event addressed by this operation.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Unique identifier of the file.
string
required
Unique identifier of the matter to which the file belongs.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
Structured JSON request body for create firm. Preserve provider field names and schema constraints.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Structured JSON request body for create a matter. Preserve provider field names and schema constraints.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_CREATE_MATTER_EXPENSECreates an expense for the specified matter. A 202 result means accepted; read back the resource to confirm completion.

Input Parameters

object
Structured JSON request body for create an expense. Preserve provider field names and schema constraints.
string
required
Identifier of the matter addressed by this operation.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_CREATE_MATTER_FEECreates a fee for the specified matter. A 202 result means accepted; read back the resource to confirm completion.

Input Parameters

object
Structured JSON request body for create a fee. Preserve provider field names and schema constraints.
string
required
Identifier of the matter addressed by this operation.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
The folder to create.
string
required
Unique identifier of the matter.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_CREATE_MATTER_MEMOCreates a memo on the specified matter. A 202 result means accepted; read back the resource to confirm completion.

Input Parameters

object
Structured JSON request body for create a memo on a matter. Preserve provider field names and schema constraints.
string
required
Identifier of the matter addressed by this operation.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Structured JSON request body for create a notification. Preserve provider field names and schema constraints.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Structured JSON request body for create firm staff member. Preserve provider field names and schema constraints.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_CREATE_SUBTASKCreates a subtask for a specified task. A 202 result means accepted; read back the resource to confirm completion.

Input Parameters

object
Structured JSON request body for create a subtask. Preserve provider field names and schema constraints.
string
required
Identifier of the task addressed by this operation.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_CREATE_TASKCreates a task. A 202 result means accepted; read back the resource to confirm completion.

Input Parameters

object
Structured JSON request body for create a task. Preserve provider field names and schema constraints.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Structured JSON request body for create a task document. Preserve provider field names and schema constraints.
string
required
Identifier of the task addressed by this operation.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Structured JSON request body for create a user. Preserve provider field names and schema constraints.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Structured JSON request body for create new webhook subscription. Preserve provider field names and schema constraints.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_DELETE_ACTIVITY_CODEDeletes an activity code. A 202 result means accepted; read back the resource to confirm completion.

Input Parameters

string
required
Identifier of the activity code addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_DELETE_AUTHORIZATION_GROUPDelete an authorization group. A 202 result means accepted; read back the resource to confirm completion.

Input Parameters

string
required
Identifier of the group addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_DELETE_CONTACTDeletes a specified contact. A 202 result means accepted; read back the resource to confirm completion.

Input Parameters

string
required
Identifier of the contact addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_DELETE_CONTACT_RELATIONDeletes a relation for a specified contact. A 202 result means accepted; read back the resource to confirm completion.

Input Parameters

string
required
Identifier of the contact addressed by this operation.
Identifier of the related contact addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_DELETE_EVENTDeletes a specified event. A 202 result means accepted; read back the resource to confirm completion.

Input Parameters

string
required
Identifier of the event addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_DELETE_EVENT_REMINDERDeletes a specified event reminder. A 202 result means accepted; read back the resource to confirm completion.

Input Parameters

string
required
Identifier of the event addressed by this operation.
string
required
Identifier of the reminder addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_DELETE_FIRM_USER_MAPPINGRemoves a user from the firm through a deprecated compatibility route, marks the associated staff and user as former, and disables user access. A 202 result means accepted; read back the resource to confirm completion.

Input Parameters

string
required
Identifier of the firm user addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_DELETE_MATTERDeletes a specified matter. A 202 result means accepted; GET_MATTER answers 404 once the matter no longer exists.

Input Parameters

string
required
Identifier of the matter addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_DELETE_MATTER_EXPENSEDeletes an expense. A 202 result means accepted; read back the resource to confirm completion.

Input Parameters

string
required
Identifier of the matter addressed by this operation.
string
required
Identifier of the expense addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_DELETE_MATTER_FEEDeletes a fee. A 202 result means accepted; read back the resource to confirm completion.

Input Parameters

string
required
Identifier of the fee addressed by this operation.
string
required
Identifier of the matter addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_DELETE_MATTER_FILEDeletes a specified matter file. A 202 result means accepted; read back the resource to confirm completion.

Input Parameters

string
required
Unique identifier (GUID) of the file.
string
required
Unique identifier (GUID) of the matter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Unique identifier of the folder.
string
required
Unique identifier of the matter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_DELETE_MATTER_MEMODeletes a specified memo. A 202 result means accepted; read back the resource to confirm completion.

Input Parameters

string
required
Identifier of the memo addressed by this operation.
string
required
Identifier of the matter addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Identifier of the staff addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_DELETE_SUBTASKDeletes a specified subtask of a specified task. A 202 result means accepted; read back the resource to confirm completion.

Input Parameters

string
required
Identifier of the task addressed by this operation.
string
required
Identifier of the subtask addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_DELETE_TASKDeletes a specified task. A 202 result means accepted; read back the resource to confirm completion.

Input Parameters

string
required
Identifier of the task addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_DELETE_TASK_DOCUMENTUnlinks the specified document from the task without deleting the underlying document. A 202 result means accepted; read back the task’s documents to confirm completion.

Input Parameters

string
required
Identifier of the task addressed by this operation.
string
required
Identifier of the document addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_DELETE_WEBHOOK_SUBSCRIPTIONDeletes and unsubscribes from the specified webhook subscription.

Input Parameters

string
required
Identifier of the webhook subscription addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_GET_ACTIVITY_CODERetrieves one activity code by id: code, description, type, whether it is billable, rate type and rate, quantity and tax flags. Use LIST_ACTIVITY_CODES to find the id.

Input Parameters

string
required
Identifier of the activity code addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_GET_AUTHORIZATION_GROUPRetrieves one authorization group by id: its name, the ids of the principals it contains, and whether it is deleted. Use LIST_AUTHORIZATION_GROUPS to find the id.

Input Parameters

string
required
Identifier of the group addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_GET_AUTHORIZATION_POLICYRetrieves one authorization policy by its reference: the principal and resource it binds and its rules. The reference is the one returned when the policy was created (CREATE_AUTHORIZATION_POLICY); Smokeball documents no list endpoint for policies.

Input Parameters

string
required
Identifier of the policy reference addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_GET_BANK_ACCOUNTRetrieves one bank account by id: type, status, linked matter, account name and number, bank and branch details. Use LIST_BANK_ACCOUNTS to find the id; balances are not part of this record.

Input Parameters

string
required
Identifier of the bank account addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_GET_BANK_ACCOUNT_TRANSACTIONRetrieves one transaction by bank account id and transaction id, including its type, amount, dates, references, associated matter and payor links, and reversal status.

Input Parameters

string
required
Identifier of the transaction addressed by this operation.
string
required
Identifier of the bank account addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_GET_CONTACTRetrieves one contact by id. Exactly one of person, company, trust or groupOfPeople is populated according to the contact kind, plus tags, isDeleted and lastUpdated. Use LIST_CONTACTS to find the id.

Input Parameters

string
required
Identifier of the contact addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_GET_CONTACT_RELATIONRetrieves a relation for a specified contact if associated with the authenticated client.

Input Parameters

string
required
Identifier of the contact addressed by this operation.
Identifier of the related contact addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Structured JSON request body containing the required ids in request order, with a maximum of 500 contact identifiers. Preserve provider field names and schema constraints.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_GET_EVENTRetrieves one calendar event by id: subject, description, location, type, start and end times in the event timeZone, allDay flag, attendees and the linked matter. Use LIST_EVENTS to find the id.

Input Parameters

string
required
Identifier of the event addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Unique identifier (GUID) of the file.
string
required
Unique identifier (GUID) of the matter.
string
Optional. Unique identifier of the file version to download. Must be a version of this file. Defaults to the current version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Unique identifier of the file.
string
required
Unique identifier of the matter to which the file belongs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Unique identifier of the file.
string
required
Unique identifier of the matter to which the file belongs.
string
required
Unique identifier of the document version to preview, as returned in ‘documentVersionId’ by CreatePreview or ‘versionId’ on the file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_GET_FIRMRetrieves the details of the firm associated with the authenticated client.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_GET_FIRM_USER_MAPPINGReturns a user-to-staff mapping in the authenticated firm through a deprecated compatibility route.

Input Parameters

string
required
Identifier of the firm user addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_GET_LAYOUT_DESIGNRetrieves one layout design by id: its name, description and the list of fields a layout matter item of this design carries. Use LIST_LAYOUT_DESIGNS to find the id.

Input Parameters

string
State identifier (optional)
string
required
Layout design Id
string
Matter type identifier (optional)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Identifier of the matter addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_GET_MATTER_ARCHIVERetrieves the archive record of a matter: whether it is archived, the archived date and location, box number, comments and destroy date. Answers 404 when the matter has no archive record.

Input Parameters

string
required
Identifier of the matter addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_GET_MATTER_BILLING_CONFIGURATIONRetrieves the billing configuration for the specified matter.

Input Parameters

string
required
Identifier of the matter addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_GET_MATTER_EXPENSERetrieves one expense on a matter by matter id and expense id: staff, amounts, tax, origin and the invoice it belongs to, if any. Use LIST_MATTER_EXPENSES to find the id.

Input Parameters

string
required
Identifier of the matter addressed by this operation.
string
required
Identifier of the expense addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_GET_MATTER_FEERetrieves one fee on a matter by matter id and fee id: staff, duration or quantity, rate, amounts, tax and the invoice it belongs to, if any. Use LIST_MATTER_FEES to find the id.

Input Parameters

string
required
Identifier of the fee addressed by this operation.
string
required
Identifier of the matter addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_GET_MATTER_FILERetrieves metadata for a file belonging to the specified matter, including its download-details link. It does not return file bytes.

Input Parameters

string
required
Unique identifier (GUID) of the file.
string
required
Identifier of the matter addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_GET_MATTER_FOLDER_PATHReturns the full folder hierarchy (path) as a collection ordered from the root folder down to the supplied folder. The root folder is not included in the response.

Input Parameters

string
required
Unique identifier of the folder.
string
required
Unique identifier of the matter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_GET_MATTER_INVOICERetrieves one invoice on a matter by matter id and invoice id: number, title, status, dates and totals. Use LIST_MATTER_INVOICES to find the id; GET_MATTER_INVOICE_DOWNLOAD_URL returns the PDF link.

Input Parameters

string
required
Identifier of the matter addressed by this operation.
string
required
Identifier of the invoice addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Identifier of the matter addressed by this operation.
string
required
Identifier of the invoice addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_GET_MATTER_ITEMRetrieves one item on a matter by matter id and item id: name, index, visibility and its subItems tree. Use LIST_MATTER_ITEMS to find the id.

Input Parameters

string
required
Identifier of the item addressed by this operation.
string
required
Identifier of the matter addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_GET_MATTER_LAYOUTRetrieves one layout item on a matter by item id, including its name, description, hierarchy and order, layout design link, values, and events.

Input Parameters

string
required
Layout item Id
string
required
Matter Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_GET_MATTER_MEMORetrieves one memo on a matter by matter id and memo id: title, rich text and plain text, author and dates, and whether it is deleted. Use LIST_MATTER_MEMOS to find the id.

Input Parameters

string
required
Identifier of the memo addressed by this operation.
string
required
Identifier of the matter addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_GET_MATTER_ROLERetrieves one role on a matter by matter id and role id: role name, the contact filling it, representatives, relationships and whether it is the client or other side. Use LIST_MATTER_ROLES to find the id.

Input Parameters

string
required
Identifier of the role addressed by this operation.
string
required
Identifier of the matter addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_GET_MATTER_ROLE_RELATIONSHIPRetrieves one relationship on a matter role by relationship id, including its name, associated contact link, and representative links.

Input Parameters

string
required
Identifier of the role addressed by this operation.
string
required
Identifier of the matter addressed by this operation.
string
required
Identifier of the relationship addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_GET_MATTER_STAGE_INFORetrieves a matter’s current stage information, including its stage set, current stage, version id, and last-updated timestamp.

Input Parameters

string
required
Identifier of the matter addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_GET_MATTER_TYPERetrieves one matter type by id: name, category, type, location, representative options and the items it defines. Use LIST_MATTER_TYPES to find the id; CREATE_MATTER needs a matterTypeId from here.

Input Parameters

string
required
Identifier of the matter type addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_GET_NOTIFICATIONRetrieves one notification by id: message, icon, creator and date, and whether it has been read or seen. Smokeball documents no list endpoint for notifications; the id comes from the notification link or a webhook event.

Input Parameters

string
required
Identifier of the notification addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_GET_PROTECTED_BANK_ACCOUNT_BALANCERetrieves one protected-funds record by bank account id and protection id, including its amount, reason, dates, current protection state, and associated matter or contact.

Input Parameters

string
required
Identifier of the bank account addressed by this operation.
string
required
Identifier of the protected balance addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_GET_REFERRAL_TYPERetrieves one referral type by id: its name and whether it is deleted. Use LIST_REFERRAL_TYPES to find the id.

Input Parameters

string
required
Identifier of the referral type addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_GET_STAFF_MEMBERRetrieves a staff member (based on staff id parameter provided) in the firm associated with the authenticated client.

Input Parameters

string
required
Identifier of the staff addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_GET_STAGE_SETReturns the stage set identified by stage_set_id, including its configured matter stages.

Input Parameters

string
required
Identifier of the stage set addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_GET_STAGE_SET_STAGERetrieves one stage of a stage set by stage-set id and stage id: name, lastUpdated and whether it is deleted. Use GET_STAGE_SET (or LIST_STAGE_SETS) to find the stage ids of a set.

Input Parameters

string
required
Identifier of the stage addressed by this operation.
string
required
Identifier of the stage set addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_GET_SUBTASKRetrieves the subtask identified by subtask_id within the specified task_id.

Input Parameters

string
required
Identifier of the task addressed by this operation.
string
required
Identifier of the subtask addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_GET_TASKRetrieves one task by id: subject, note, due date, assignees, sub-tasks, the linked matter and who created, completed or last updated it. Use LIST_TASKS to find the id.

Input Parameters

string
required
Identifier of the task addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_GET_TASK_DOCUMENTRetrieves one document attached to a task by task id and document id, including its document type, deletion state, associated task, and document link.

Input Parameters

string
required
Identifier of the task addressed by this operation.
string
required
Identifier of the document addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_GET_USERRetrieves the Smokeball user identified by user_id.

Input Parameters

string
required
Identifier of the user addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_GET_WEBHOOK_SUBSCRIPTIONReturns the webhook subscription identified by webhook_subscription_id, including its callback and subscribed events.

Input Parameters

string
required
Identifier of the webhook subscription addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Maximum records to return; must be between 1 and 500.
string
Continuation cursor. Omit for the first page; pass back the next_cursor of the previous response, together with the same filters and limit, to read the next page.
integer
Returns activity codes updated since a specified time (.net ticks representation of the UTC datetime).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_LIST_AUTHORIZATION_GROUPSReturn the authorization groups for the firm associated with the authenticated client. The provider returns paged metadata and 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Maximum records to return; must be between 1 and 500.
string
Continuation cursor. Omit for the first page; pass back the next_cursor of the previous response, together with the same filters and limit, to read the next page.
string
Filters items by the specified matter ID.
string
Returns items updated since the specified date and time.
string
required
Identifier of the bank account addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_LIST_BANK_ACCOUNTSReturns bank accounts available to the authenticated firm, optionally filtered by account type or matter identifier.

Input Parameters

string
Provider bank-account type filter; supported values are not documented in the spec.
string
Filter bank accounts using this matter identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Identifier of the contact addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_LIST_CONTACTSReturns a list of contacts. Returns one page; pass next_cursor back as cursor to read the next one.

Input Parameters

string
Sort field. The documented value is lastUpdated.
array
Filters result by one more contact types if set. Returns all contact types by default. Possible values: Staff, Person, Organisation, GroupOfPeople, Trust
integer
Maximum records to return; must be between 1 and 500.
string
Continuation cursor. Omit for the first page; pass back the next_cursor of the previous response, together with the same filters and limit, to read the next page.
string ("passportDetails" | "deathDetails" | "citizenshipDetails" | "utbmsDetails" | "tags" | "executionOptions" | "voiDetails")
Additional contact field to include. Use a documented value.
integer
Returns contacts updated since a specified time (.net ticks representation of the UTC datetime).
boolean
Excludes (filters out) deleted contacts if set to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_LIST_CONTACT_TAGSLists the tags currently on one contact, by contact id, as a plain string collection under value. Use ADD_CONTACT_TAGS or REMOVE_CONTACT_TAG to change them.

Input Parameters

string
required
Identifier of the contact addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_LIST_EVENT_REMINDERSReturns the collection of reminders for an event The native root response is returned under data as an explicit Composio normalization.

Input Parameters

string
required
Identifier of the event addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_LIST_EVENTSReturns a list of events. Returns one page; pass next_cursor back as cursor to read the next one.

Input Parameters

string
Filter events to a specified UTC date and time. If no datetime is specified all future events will be returned. Dates should be provided in ISO format YYYY-MM-DDThh:mm:ss.
integer
Maximum records to return; must be between 1 and 500.
string
Continuation cursor. Omit for the first page; pass back the next_cursor of the previous response, together with the same filters and limit, to read the next page.
string
Filter events from a specified UTC date and time. Defaults to the UTC datetime of the request. Dates should be provided in ISO format YYYY-MM-DDThh:mm:ss.
string
Filter by events assigned to a specific MatterId.
string
Filter by events updated since a specified time. Supported date formats are ISO YYYY-MM-DDThh:mm:ss or .net ticks representation of the UTC datetime.
boolean
Filter out any events that have been deleted, default: false

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_LIST_FILE_HISTORYReturns the full list of history entries for the specified file. The result is not paged.

Input Parameters

string
required
Unique identifier (GUID) of the file.
string
required
Unique identifier (GUID) of the matter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Maximum records to return; must be between 1 and 500.
string
Continuation cursor. Omit for the first page; pass back the next_cursor of the previous response, together with the same filters and limit, to read the next page.
string
Deprecated, use updatedSince Returns items updated since a specified time.
integer
Returns items updated since a specified time (.net ticks representation of the UTC datetime).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_LIST_FIRM_USER_MAPPINGSLists user-to-staff mappings in the authenticated firm.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_LIST_FOLDER_HISTORYReturns a list of history entries for the specified folder. The response is not paged. An unknown folder id returns 200 with an empty collection rather than 404.

Input Parameters

string
required
Unique identifier of the folder.
string
required
Unique identifier of the matter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Maximum records to return; must be between 1 and 500.
string
Continuation cursor. Omit for the first page; pass back the next_cursor of the previous response, together with the same filters and limit, to read the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Maximum records to return; must be between 1 and 500.
string
Continuation cursor. Omit for the first page; pass back the next_cursor of the previous response, together with the same filters and limit, to read the next page.
string
required
Identifier of the matter addressed by this operation.
integer
Returns expenses updated since a specified time (.net ticks representation of the UTC datetime).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Maximum records to return; must be between 1 and 500.
string
Continuation cursor. Omit for the first page; pass back the next_cursor of the previous response, together with the same filters and limit, to read the next page.
string
required
Identifier of the matter addressed by this operation.
integer
Returns fees updated since a specified time (.net ticks representation of the UTC datetime).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Sort field. The documented value is dateCreated.
integer
Maximum records to return; must be between 1 and 500.
string
Provider file-list continuation token. Its interaction with Offset and next.href is not documented; do not invent or mix continuation modes.
The docs list searchable fields query and fileExtension but do not define Search item syntax. Callers must follow the provider expression format.
string
required
Unique identifier (GUID) of the matter.
string
Continuation cursor for the next page of this action’s own paging, distinct from the provider’s cursor parameter. Omit for the first page; pass back the next_page_cursor of the previous response, together with the same filters and limit, to read the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Maximum records to return; must be between 1 and 500.
string
Continuation cursor. Omit for the first page; pass back the next_cursor of the previous response, together with the same filters and limit, to read the next page.
string
Unique identifier of a folder. Omit to list the matter’s root document folder.
string
required
Unique identifier of the matter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Maximum records to return; must be between 1 and 500.
string
Continuation cursor. Omit for the first page; pass back the next_cursor of the previous response, together with the same filters and limit, to read the next page.
string
required
The unique identifier of the matter that the invoice belongs to.
string
Returns items updated since the specified date and time.
integer
Returns items updated since a specified time (.net ticks representation of the UTC datetime).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_LIST_MATTER_ITEMSReturns the versioned item collection for a matter. Each item includes its name, zero-based index, visibility, and nested sub-items.

Input Parameters

string
required
Identifier of the matter addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_LIST_MATTER_LAYOUT_CONTACTSReturns a list of contacts on a specified layout. The native root response is returned under data as an explicit Composio normalization.

Input Parameters

string
required
Identifier of the layout item whose contacts are listed.
string
required
Identifier of the matter addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_LIST_MATTER_LAYOUTSReturns a collection of layout items on a specified matter.

Input Parameters

string
required
Matter Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Maximum records to return; must be between 1 and 500.
string
Continuation cursor. Omit for the first page; pass back the next_cursor of the previous response, together with the same filters and limit, to read the next page.
string
required
Identifier of the matter addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_LIST_MATTER_ROLE_RELATIONSHIPSReturns associated relationships for a specified matter and role group.

Input Parameters

string
required
Identifier of the matter addressed by this operation.
string
required
Identifier of the role group whose relationships are listed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_LIST_MATTER_ROLESReturns associated roles for a specified matter.

Input Parameters

string
required
Identifier of the matter addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("status" | "lastUpdated")
Sort by a documented field: status or lastUpdated.
string ("Matters" | "Leads" | "Matters,Leads")
Matter kind to return: “Matters”, “Leads”, or “Matters,Leads”.
integer
Maximum records to return; must be between 1 and 500.
string
Continuation cursor. Omit for the first page; pass back the next_cursor of the previous response, together with the same filters and limit, to read the next page.
string
Filter matters by clients, other sides, descriptions, or matter numbers.
array
Filter by matter status: Open, Pending, Closed, Deleted, or Cancelled.
boolean
Return leads when true. Deprecated by Smokeball in favor of Type.
string
Filter by contact identifier.
string
Filter by last-updated date; cannot be combined with UpdatedSince.
integer
Filter by .NET UTC ticks; cannot be combined with LastUpdated. Deprecated in favor of LastUpdated.
string
Filter by matter type identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_LIST_MATTER_TAGSReturns the tags assigned to the matter identified by matter_id.

Input Parameters

string
required
Identifier of the matter addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_LIST_MATTER_TYPE_CATEGORIESReturns a list of all the possible matter type categories.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Searches for partial match on matter type name
integer ("0" | "1")
Return matter types by category type (i.e. MatterType or LeadType). Possible values: Matter Type = 0, Lead Type = 1.
integer
Maximum records to return; must be between 1 and 500.
string
Continuation cursor. Omit for the first page; pass back the next_cursor of the previous response, together with the same filters and limit, to read the next page.
string
Return matter types from a specific category.
string
Return matter types from a specific location. In the US API this is the ANSI 2 letter state code (e.g. IL, NY). In the AU API this is shorthand state code (e.g. NSW, ACT, etc)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_LIST_REFERRAL_TYPESReturns referral types, including custom referral types.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Maximum records to return; must be between 1 and 500.
string
Continuation cursor. Omit for the first page; pass back the next_cursor of the previous response, together with the same filters and limit, to read the next page.
string
Additional staff field to include: rate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Maximum records to return; must be between 1 and 500.
string
Continuation cursor. Omit for the first page; pass back the next_cursor of the previous response, together with the same filters and limit, to read the next page.
string
Deprecated, use updatedSince Returns items updated since a specified time.
integer
Returns items updated since a specified time (.net ticks representation of the UTC datetime).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_LIST_SUBTASKSReturns a list of subtasks for a specified task if associated with the authenticated client.

Input Parameters

string
required
Identifier of the task addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_LIST_TASK_DOCUMENTSReturns a list of document links for the specified task, if associated with the authenticated client.

Input Parameters

string
required
Identifier of the task addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_LIST_TASKSReturns a list of tasks. Returns one page; pass next_cursor back as cursor to read the next one.

Input Parameters

integer
Maximum records to return; must be between 1 and 500.
string
Continuation cursor. Omit for the first page; pass back the next_cursor of the previous response, together with the same filters and limit, to read the next page.
string
Filter by tasks that are assigned to the specified matter id..
boolean
Filter to completed tasks when true. Omit to leave completion status unfiltered.
string
Filter by last updated date of a task. Cannot be used in conjunction with UpdatedSince.
integer
Filter by tasks updated since a specified time (.net ticks representation of the UTC datetime). Cannot be used in conjunction with LastUpdated. This field will not be supported in future, please use LastUpdated instead.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_LIST_WEBHOOK_EVENT_TYPESLists the event type names a webhook subscription can subscribe to, as a plain string collection under value. Use one or more of them in CREATE_WEBHOOK_SUBSCRIPTION.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_LIST_WEBHOOK_SUBSCRIPTIONSReturns existing webhook subscriptions. Returns one page; pass next_cursor back as cursor to read the next one.

Input Parameters

integer
Maximum records to return; must be between 1 and 500.
string
Continuation cursor. Omit for the first page; pass back the next_cursor of the previous response, together with the same filters and limit, to read the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Layout data to merge, without untyped value state.
string
required
Matter item identifier.
string
required
Matter identifier.
boolean
Bypass field validation; may be needed for Smokeball data-split migrations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Documented patch-matter body without the recursive items property.
string
required
Identifier of the matter to patch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Structured JSON request body for patch an archive for a matter. Preserve provider field names and schema constraints.
string
required
Identifier of the matter addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Structured JSON request body for patch matter billing configuration. Preserve provider field names and schema constraints.
string
required
Identifier of the matter addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Structured JSON request body for patch an expense. Preserve provider field names and schema constraints.
string
required
Identifier of the matter addressed by this operation.
string
required
Identifier of the expense addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Structured JSON request body for patch a fee. Preserve provider field names and schema constraints.
string
required
Identifier of the fee addressed by this operation.
string
required
Identifier of the matter addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
The properties to change as a merge-style object.
string
required
Unique identifier (GUID) of the file.
string
required
Unique identifier (GUID) of the matter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
The fields to update as a merge-style object.
string
required
Unique identifier of the folder.
string
required
Unique identifier of the matter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Structured JSON request body for protect bank account funds. Preserve provider field names and schema constraints.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.
string
required
Identifier of the bank account addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_REMOVE_CONTACT_TAGRemoves one tag from a contact. The documented bulk form is unavailable because its route simultaneously marks tagId as required and optional. A 202 result means accepted; read back the contact to confirm completion.

Input Parameters

string
required
Identifier of the tag to remove.
string
required
Identifier of the contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_REMOVE_MATTER_LAYOUTRemoves a layout matter item from a matter. A 202 result means accepted; read back the resource to confirm completion. Parent deletion can affect sub-items, and deleted layouts cannot be recovered via the API.

Input Parameters

string
required
Layout matter item ID to remove
string
required
Matter ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_REMOVE_MATTER_LAYOUT_CONTACTRemoves a contact from a specified layout, deleting the associated role or relationship from the matter. A 202 result means accepted; read back the resource to confirm completion.

Input Parameters

string
Layout contact key identifying the contact to remove.
string
required
Identifier of the layout item containing the contact.
string
required
Matter Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_REMOVE_MATTER_ROLERemoves a specified role from a matter. A 202 result means accepted; read back the resource to confirm completion.

Input Parameters

string
required
Identifier of the role addressed by this operation.
integer
Provider version header; supported values and purpose are not documented in this operation. Omit unless Smokeball instructs you to send it.
string
required
Identifier of the matter addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Identifier of the role addressed by this operation.
integer
Provider version header; supported values and purpose are not documented in this operation. Omit unless Smokeball instructs you to send it.
string
required
Identifier of the matter addressed by this operation.
string
required
Identifier of the relationship addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Structured JSON request body for remove tags from a matter. Preserve provider field names and schema constraints.
string
required
Identifier of the tag addressed by this operation.
string
required
Identifier of the matter addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Structured JSON request body for search files with advanced filters. Preserve provider field names and schema constraints.
integer
Maximum records to return; must be between 1 and 500.
integer
Number of records to skip before this page; minimum 0.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Structured JSON request body for unprotect bank account funds. Preserve provider field names and schema constraints.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.
string
required
Identifier of the protection addressed by this operation.
string
required
Identifier of the bank account addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_UPDATE_ACTIVITY_CODEUpdates an activity code. A 202 result means accepted; read back the resource to confirm completion.

Input Parameters

object
Structured JSON request body for update an activity code. Preserve provider field names and schema constraints.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.
string
required
Identifier of the activity code addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_UPDATE_AUTHORIZATION_GROUPUpdates a specified authorization group. A 202 result means accepted; read back the resource to confirm completion.

Input Parameters

object
Structured JSON request body for update an authorization group. Preserve provider field names and schema constraints.
string
required
Identifier of the group addressed by this operation.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_UPDATE_AUTHORIZATION_POLICYUpdates a specified authorization policy. A 202 result means accepted; read back the resource to confirm completion.

Input Parameters

object
Structured JSON request body for update an authorization policy. Preserve provider field names and schema constraints.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.
string
required
Identifier of the policy reference addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Structured JSON request body for update a contact. Preserve provider field names and schema constraints.
string
required
Identifier of the contact addressed by this operation.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_UPDATE_CONTACT_RELATIONUpdates a relation for a specified contact. A 202 result means accepted; read back the resource to confirm completion.

Input Parameters

object
Structured JSON request body for update a contact relation. Preserve provider field names and schema constraints.
string
required
Identifier of the contact addressed by this operation.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.
Identifier of the related contact addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Structured JSON request body for update event. Preserve provider field names and schema constraints.
string
required
Identifier of the event addressed by this operation.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_UPDATE_EVENT_REMINDERUpdates an existing reminder for an event. A 202 result means accepted; read back the resource to confirm completion.

Input Parameters

object
Structured JSON request body for update a reminder for an event. Preserve provider field names and schema constraints.
string
required
Identifier of the event addressed by this operation.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.
string
required
Identifier of the reminder addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_UPDATE_FIRMUpdates firm details for the current authenticated client. A 202 result means accepted; read back the resource to confirm completion.

Input Parameters

object
Structured JSON request body for update firm. Preserve provider field names and schema constraints.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Structured JSON request body for update firm user mapping. Preserve provider field names and schema constraints.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.
string
required
Identifier of the firm user addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Structured JSON request body for update a matter. Preserve provider field names and schema constraints.
string
required
Identifier of the matter addressed by this operation.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Structured JSON request body for update an archive for a matter.. Preserve provider field names and schema constraints.
string
required
Identifier of the matter addressed by this operation.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Structured JSON request body for update matter billing configuration. Preserve provider field names and schema constraints.
string
required
Identifier of the matter addressed by this operation.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Structured JSON request body for update an expense. Preserve provider field names and schema constraints.
string
required
Identifier of the matter addressed by this operation.
string
required
Identifier of the expense addressed by this operation.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Structured JSON request body for update a fee. Preserve provider field names and schema constraints.
string
required
Identifier of the fee addressed by this operation.
string
required
Identifier of the matter addressed by this operation.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
The full set of editable file properties.
string
required
Unique identifier (GUID) of the file.
string
required
Unique identifier (GUID) of the matter.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
The full set of folder fields to apply.
string
required
Unique identifier of the folder.
string
required
Unique identifier of the matter.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_UPDATE_MATTER_MEMOUpdates a specified memo. A 202 result means accepted; read back the resource to confirm completion.

Input Parameters

object
Structured JSON request body for update a memo. Preserve provider field names and schema constraints.
string
required
Identifier of the memo addressed by this operation.
string
required
Identifier of the matter addressed by this operation.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_UPDATE_MATTER_ROLEUpdates a specified role on a matter. A 202 result means accepted; read back the resource to confirm completion.

Input Parameters

object
Structured JSON request body for update role on a matter. Preserve provider field names and schema constraints.
string
required
Identifier of the role addressed by this operation.
string
required
Identifier of the matter addressed by this operation.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Structured JSON request body for update a relationship. Preserve provider field names and schema constraints.
string
required
Identifier of the role addressed by this operation.
string
required
Identifier of the matter addressed by this operation.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.
string
required
Identifier of the relationship addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Structured JSON request body for update firm staff member. Preserve provider field names and schema constraints.
string
required
Identifier of the staff addressed by this operation.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_UPDATE_SUBTASKUpdates a specified subtask of a specified task. A 202 result means accepted; read back the resource to confirm completion.

Input Parameters

object
Structured JSON request body for update a subtask. Preserve provider field names and schema constraints.
string
required
Identifier of the task addressed by this operation.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.
string
required
Identifier of the subtask addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMOKEBALL_UPDATE_TASKUpdates a specified task. A 202 result means accepted; read back the resource to confirm completion.

Input Parameters

object
Structured JSON request body for update a task. Preserve provider field names and schema constraints.
string
required
Identifier of the task addressed by this operation.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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.

Input Parameters

object
Structured JSON request body for update a webhook subscription. Preserve provider field names and schema constraints.
string
Optional documented correlation header for asynchronous writes and webhook callbacks; does not prove completion.
string
required
Identifier of the webhook subscription addressed by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not