Skip to Content
HelvetlyDocs
API referenceDocuments

Share 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.

POST
/api/v1/documents/{id}/shares

Makes a live document visible to a client in the client portal (the client must be able to sign in to the portal). Answers 204; sharing again is a no-op. 404 for an unknown or deleted document or client.

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.

Request Body

application/json
  1. body
client_id*string

A client of the workspace.

Response Body

Shared.

Example Request
curl -X POST 'https://app.helvetly.com/api/v1/documents/string/shares' \  -H 'Content-Type: application/json' \  -d '{  "client_id": "cli_01JABCDEF"}'
Example Response
Empty

List who a document is shared with

Previous Page

Stop sharing a document with a client

Next Page