Send Test Message

Send a one-off test email of a schedule message to a single address, resolving every {{variable}}. With attach_pdf (which requires template_id) the report is built asynchronously and the email follows; never affects any saved schedule.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request body for sending a test delivery to schedule recipients.

string
required

The client the test deliverable would be sent for; resolves {{client}} and validates access.

string | null

The template a real fire would build from. Required only with attach_pdf, which renders the
attached PDF from it; when supplied it is validated for account ownership and, for the PDF path,
client-plan section access. A text-only test renders no sections and may omit it.

string
required

The draft email subject to render. May contain {{...}} variable markers.

string
required

The draft email body to render. May contain {{...}} variable markers.

string
required

The address that receives the one-off test email. Recipient variables still resolve against
the recipient field.

cadence
object | null

The draft cadence. Optional — when supplied, {{month_year}} resolves to the month of the next
occurrence; otherwise it resolves to the current month.

recipient
object | null

The recipient used to resolve recipient variables. Optional; a sample recipient is used when omitted.
Distinct from test_email, which receives the test email.

string | null
enum

The draft share-link expiry window, used to render the expiry line inside {{share_link}}.
Optional; defaults to seven days when omitted. Unlimited renders as never expiring.

Allowed:
boolean | null

The draft attach_pdf setting. Defaults to false when omitted. When true the test carries a
real PDF rendered from the template, which is generated asynchronously — the response means the
test was accepted, and the email arrives once the report has been built.

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses
200

OK

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json