Skip to content

Preview Quote Send

POST
/quotes/{quote_id}/send-preview

Render the exact email and document /send would produce. SENDS NOTHING.

Takes the identical body to /send on purpose - a preview rendered from a different body predicts nothing. deliver is accepted and inert.

Tiered as a READ: it renders and returns, and nothing in the handler reaches a mail transport.

Authorizations

Parameters

Path Parameters

quote_id
required

Quote id (UUID).

string

Quote id (UUID).

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

The same body POST /quotes/{id}/send takes - rendered, not sent.

Identical on purpose: previewing with a different body than you send is how a preview stops predicting anything. deliver is accepted because the app’s model has it, and it is INERT here - this handler renders and returns, and nothing in it reaches a mail transport.

object
cc_emails
Any of:
Array<string>
deliver
boolean
default: true
email_body
Any of:
string
message
Any of:
string
notification_mode
string
default: after_each
Allowed values: after_each after_all
preview_recipient_email
Any of:
string
recipient_email
Any of:
string
recipient_name
Any of:
string
recipients
Any of:
Array<object>

One recipient of a quote preview.

object
email
required
string
<= 255 characters
email_body
Any of:
string
<= 10000 characters
name
Any of:
string
<= 255 characters
role
string
default: signer
Allowed values: signer viewer
subject
Any of:
string
<= 500 characters
subject
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for a quote, template, contact or job result.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string