Soft delete a client
Performs a soft delete on a client by setting the deletedAt timestamp. The client and all related data are hidden but not permanently removed from the database.
Soft Delete Behavior:
- Client marked as deleted (deletedAt set to current timestamp)
- Client no longer appears in queries or listings
- All related invoices and documents are preserved but no longer accessible via API
- Historical financial data remains intact for compliance/audit purposes
- Data can be recovered by database administrator if needed
Multi-Tenant Security: Only users who own the business that this client belongs to can delete this client.
Impact on Documents:
- Existing invoices/receipts remain intact but hidden
- Cannot create new documents for deleted client
- Document history preserved for tax compliance
Warning: Consider setting isActive=false instead if you want to temporarily disable a client without affecting document history access.
Example Use Case: Client relationship ended, but historical invoices need to be preserved for 7+ years per Israeli tax law requirements.
Business API key, e.g. vuz_ab12cdef... Created via Settings → Integrations → API Keys. Unlike partner keys, a public API key's STRING does not encode its environment — isolation instead comes from a completely separate sandbox database: a key minted on the Sandbox server (above) only ever reads/writes sandbox data and can never see or affect production, regardless of what the key looks like.
In: header
Path Parameters
Client unique identifier (UUID)
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "https://example.com/clients/770e8400-e29b-41d4-a716-446655440000"{ "message": "Client deleted successfully"}