VUZDevelopers

Send document via email with branded template

POST
/documents/{id}/share/email

Sends a document to a recipient via email with a branded HTML template.

Features:

  • Branded email with business logo and colors
  • Document summary (type, number, amount, due date)
  • Custom message from sender
  • "View Document" button with share link
  • Automatic share link creation/reuse

Email Contents:

  • Business branding (logo, name, contact info)
  • Client greeting
  • Custom message (if provided)
  • Document details table
  • Call-to-action button to view document
  • Link expiration notice

Example Request:

{  "recipientEmail": "client@example.com",  "subject": "Your Invoice #1001",  "message": "Thank you for your business! Please find your invoice attached.",  "includePdf": true,  "expiresInDays": 30}

Authorization

X-Api-Key<token>

Business API key, e.g. vuz_ab12cdef... Created via Settings → Integrations → API Keys. Unlike partner keys, a public API key's STRING does not encode its environment — isolation instead comes from a completely separate sandbox database: a key minted on the Sandbox server (above) only ever reads/writes sandbox data and can never see or affect production, regardless of what the key looks like.

In: header

Path Parameters

id*string

Document ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/documents/550e8400-e29b-41d4-a716-446655440000/share/email" \  -H "Content-Type: application/json" \  -d '{}'
{  "success": true,  "message": "Email sent successfully",  "shareUrl": "https://app.example.com/share/abc123-xyz789",  "emailSentAt": "2025-12-07T10:30:00.000Z",  "trackingId": "ses-message-id-123",  "paymentLinkUrl": "https://app.example.com/pay/abc123",  "paymentLinkId": "pl_abc123xyz",  "sentTo": [    "client@example.com",    "accountant@example.com"  ],  "failedTo": [    "string"  ]}