Skip to Content
HelvetlyDocs
API referenceClients

Delete a client

Needs a token with the write:clients scope. Authentication

Try in Playground sends a real request to app.helvetly.com with a token you paste. It stays in this browser tab only (session storage) and goes to no one else.

DELETE
/api/v1/clients/{id}

Soft-deletes the client: it disappears from lists and can no longer be fetched or edited (404), its portal sessions end, and its number is never reused. Issued invoices keep their buyer snapshot and stay creditable; nothing is deleted from the books. Only owners and admins may delete (403 forbidden otherwise). The record cannot be restored through the API, and a retry answers 404. 204 on success.

Authorization

bearerAuth
headerAuthorizationBearer <token>

A personal API token, hvt_…, with scopes such as read:* or write:invoices

Path Parameters

id*string

The client's id.

Response Body

No content

Example Request
curl -X DELETE 'https://app.helvetly.com/api/v1/clients/string'
Example Response
Empty