Skip to Content
HelvetlyDocs
API referenceDocuments

Stop sharing a document with a client

Needs a token with the write:documents 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/documents/{id}/shares

Removes the client's access to the document in the portal. The client is given as the query parameter client_id (a path segment is not possible here). Answers 204; repeating it is a no-op. 400 invalid_request when client_id is missing.

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Path Parameters

id*string

The document's id.

Query Parameters

client_id*string

The client to stop sharing with.

Response Body

No longer shared.

Example Request
curl -X DELETE 'https://app.helvetly.com/api/v1/documents/string/shares?client_id=string'
Example Response
Empty