Sign in

v4

latestOpenAPI 3.1.02026-08-03427198448.4 KB

Render Contextual Email Preview

Render an email exactly as it would be sent for the given entity, without sending. Used by the in-dialog EmailPreviewPanel on the frontend.

Read-only: never writes to DB, never sends an email.

post/api/email-preview/contextual

Query parameters

user_idstring
org_idstring

Request body

kindstring required

One of: invoice_send, invoice_test, invoice_payment_reminder, proposal_send, proposal_test, payment_confirmation

entity_idstring required

Invoice / proposal / payment ID

custom_messagestring nullable
test_emailstring nullable

Response

Successful Response

kindstring required
template_namestring required
subjectstring required
tostring[] required
ccstring[] required
from_labelstring required
reply_tostring required
htmlstring required
warningsstring[] required