Clients
Delete a client
Requires a key with the write_enhanced scope.
By default this is a soft delete and the client can be restored in Soraban. Passing hardDelete=true permanently destroys the client and their entities, which cannot be undone.
A client shared with another firm cannot be deleted through the API.
delete/clients/{id}
Request
- Base URLhttps://api.soraban.com
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
hardDeleteboolean
Permanently destroy the client instead of soft-deleting. Irreversible.
Response
Success.
Example response
{
"message": "Client deleted."
}Changes
No recorded changes to this operation across all 2 revisions of this API.