Skip to main content
POST
Send document email

Authorizations

Authorization
string
header
required

Bearer token created for a specific company in Integrations → API.

Headers

Idempotency-Key
string

Optional request identifier for safe retries. Use a unique value for each create request you want to retry safely.

Example:

"invoice-create-2026-03-03-001"

Body

application/json

Payload used to send a supported document by email. The target document is selected through documentType + documentId and must be available in the token scope.

documentType
enum<string>
required

Document type you want to send by email.

Available options:
invoice,
proforma,
order,
credit-note,
quotation
Example:

"invoice"

documentId
integer
required

ID of a supported document.

Example:

301

to
string<email>[]
required

Array of one or more target email addresses.

Minimum array length: 1
Example:
type
enum<string>
required

Mail type. For invoice and proforma, it changes the subject and template type; for order, credit-note, and quotation, it currently behaves the same as regular.

Available options:
regular,
reminder,
overdue_reminder,
confirmation
Example:

"reminder"

body
string | null

Optional custom text inserted into the email body.

Maximum string length: 1000
Example:

"Please find the document attached."

Response

Document send request accepted.