API referenceDocuments
Remove a document link
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
Removes one link (type client, invoice, expense or signature, and the target's id) and answers with the document. A link that makes the document a business record (retains true) cannot be removed: 409 retained. 404 when there is no such link.
bearerAuthheader
AuthorizationBearer <token>A personal API token, hvt_…, with scopes such as read:* or write:invoices
id*stringThe document's id.
type*stringLink type: client, invoice, expense or signature.
Value in
"client""invoice""expense""signature"target*stringId of the linked record.
OK
application/json- response
data*A document's metadata. The bytes come from download_document and get_document_content.
curl -X DELETE 'https://app.helvetly.com/api/v1/documents/string/links/client/string'Example Response
{ "data": { "id": "string", "name": "string", "folder_id": "string", "folder": { "id": "string", "name": "string" }, "size": 0, "content_type": "string", "kind": "pdf", "previewable": true, "sha256": "string", "links": [ { "type": "string", "id": "string", "label": "string", "retains": true } ], "retained_until": "2019-08-24", "uploaded_by": { "id": "string", "name": "string" }, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deleted_by": { "id": "string", "name": "string" }, "purge_at": "2019-08-24T14:15:22Z" }}