Update the sync settings of a destination

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://docs.usehearsay.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
{
  "integrations MCP server": {
    "url": "https://docs.usehearsay.com/mcp"
  }
}

Close
PATCH /legal/{provider}/settings

Updates the organization's sync settings for one destination; only the fields sent change. For Clio and Smokeball the webhook registration follows the change, and a webhook failure is logged without failing the save. Dropbox has outbound settings only, so sending cases or documents for it returns 400, as does an unknown provider. Requires an org admin or owner.

Headers

  • organization string Required

    id of the selected (active) organization

Path parameters

  • provider string Required

    Export destination: a CMP (clio, smokeball) or a storage backend (dropbox). Storage destinations are outbound-only — sending 'cases' or 'documents' for one is a 400.

    Values are clio, smokeball, or dropbox.

application/json

Body Required

  • cases object
    Hide cases attributes Show cases attributes object
    • autoCreateFromWebhook boolean

      Auto-create a Hearsay case when a matter is created in Clio

    • autoCollection object
      Hide autoCollection attributes Show autoCollection attributes object
      • enabled boolean

        Pre-configure the auto-created case + attach the client as custodian (fires the collection email). Requires autoCreateFromWebhook.

      • template object
        Hide template attributes Show template attributes object
        • caseType string Required

          Front case-type vocabulary (e.g. "employment")

        • sources array[string] Required

          Pre-mapped MasterDataSourceName values

          Values are ios, android, facebook_dump, instagram_dump, threads_dump, gmail, yahoo, outlook, icloud, imap, ews, files, bank-docs, linkedin_dump, claude_dump, chatgpt_dump, or gemini_dump.

        • roles array[object] Required
          Hide roles attributes Show roles attributes object
          • role string Required

            Collection role, e.g. "Ex-Spouse"

          • hint string
          • required boolean Required
          • channels array[string] Required

            Delivery channels, e.g. ["email", "slack_teams"]

        • documentRequests array[string] Required
        • dateRange object
          Hide dateRange attributes Show dateRange attributes object
          • start string(date-time) | null
          • end string(date-time) | null
  • documents object
    Hide documents attribute Show documents attribute object
    • autoSync boolean

      Enable automatic document sync from Clio

  • dataSources object
    Hide dataSources attributes Show dataSources attributes object
    • file object
      Hide file attribute Show file attribute object
      • enabled boolean
    • email object
      Hide email attributes Show email attributes object
      • enabled boolean
      • format string

        Values are pdf or eml.

    • device object
      Hide device attributes Show device attributes object
      • enabled boolean
      • format string

        Values are pdf or rsf.

    • financial object
      Hide financial attributes Show financial attributes object
      • enabled boolean
      • format string

        Values are pdf or csv.

      • types object
        Hide types attributes Show types attributes object
        • transactions boolean

          Export bank transactions

        • recurringTransactions boolean

          Export recurring transactions

        • holdings boolean

          Export holdings

        • liabilities boolean

          Export liabilities

        • investmentTransactions boolean

          Export investment transactions

        • statements boolean

          Export account statements as a ZIP bundle (out-of-band). Drives the default (no-filter) export; an explicit financial filter with a statements-bundle item overrides this toggle.

    • reddit object
      Hide reddit attribute Show reddit attribute object
      • enabled boolean
    • discord object
      Hide discord attribute Show discord attribute object
      • enabled boolean

Responses

  • 204

    Settings saved. No body.

PATCH /legal/{provider}/settings
curl \
 --request PATCH 'http://api.example.com/legal/{provider}/settings' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "organization: string" \
 --data '{
  "cases": {
    "autoCreateFromWebhook": true,
    "autoCollection": {
      "enabled": true,
      "template": {
        "caseType": "string",
        "sources": [
          "ios"
        ],
        "roles": [
          {
            "role": "string",
            "hint": "string",
            "required": true,
            "channels": [
              "string"
            ]
          }
        ],
        "documentRequests": [
          "string"
        ],
        "dateRange": {
          "start": "2026-05-04T09:42:00Z",
          "end": "2026-05-04T09:42:00Z"
        }
      }
    }
  },
  "documents": {
    "autoSync": true
  },
  "dataSources": {
    "file": {
      "enabled": true
    },
    "email": {
      "enabled": true,
      "format": "pdf"
    },
    "device": {
      "enabled": true,
      "format": "pdf"
    },
    "financial": {
      "enabled": true,
      "format": "pdf",
      "types": {
        "transactions": true,
        "recurringTransactions": true,
        "holdings": true,
        "liabilities": true,
        "investmentTransactions": true,
        "statements": true
      }
    },
    "reddit": {
      "enabled": true
    },
    "discord": {
      "enabled": true
    }
  }
}'
Request examples
# Headers
organization: string

# Payload
{
  "cases": {
    "autoCreateFromWebhook": true,
    "autoCollection": {
      "enabled": true,
      "template": {
        "caseType": "string",
        "sources": [
          "ios"
        ],
        "roles": [
          {
            "role": "string",
            "hint": "string",
            "required": true,
            "channels": [
              "string"
            ]
          }
        ],
        "documentRequests": [
          "string"
        ],
        "dateRange": {
          "start": "2026-05-04T09:42:00Z",
          "end": "2026-05-04T09:42:00Z"
        }
      }
    }
  },
  "documents": {
    "autoSync": true
  },
  "dataSources": {
    "file": {
      "enabled": true
    },
    "email": {
      "enabled": true,
      "format": "pdf"
    },
    "device": {
      "enabled": true,
      "format": "pdf"
    },
    "financial": {
      "enabled": true,
      "format": "pdf",
      "types": {
        "transactions": true,
        "recurringTransactions": true,
        "holdings": true,
        "liabilities": true,
        "investmentTransactions": true,
        "statements": true
      }
    },
    "reddit": {
      "enabled": true
    },
    "discord": {
      "enabled": true
    }
  }
}