Send Test Message

Send a one-off test email of a schedule message to a single address, resolving every {{variable}}. Does not create a deliverable or affect 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
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
Wm.Beast.Deliverable.Packages.DeliverableTemplate.Packages.DeliverableSchedule.Controller.Public.ScheduleSendTest.Request.Recipient.

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 Wm.Beast.Deliverable.Packages.DeliverableTemplate.Packages.DeliverableSchedule.Controller.Public.ScheduleSendTest.Request.TestEmail, which receives the test email.

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