Skip to main content
POST
Renders the email a declaration would produce for one sample row and delivers

Authorizations

Authorization
string
header
required

An Erdo API key (erdo_api_...) or scoped token (erdo_token_...).

Body

application/json
dataset
string

and authorised exactly as a save would resolve it: testing what you are about to declare is the same privilege as declaring it.

deliver_to
string

address a test send can ever reach. Whatever the declaration's own `to` renders to is replaced with it.

row
One column of the sample row a test send renders against. · object[]
steps
One step of a declaration. A step is EITHER an action to invoke (app and key) · object[]

takes them. A test send accepts one shape only: zero or more script steps followed by exactly one erdo/send_email step. Any other action is refused, so nothing paid or approval-gated is ever invoked to answer this call.

Response

Success response

sent
boolean
skipped
string

the data a required placeholder needs is skipped rather than sent, which is exactly what would happen to a real row — and it is the most useful thing a test can report.

subject
string

went out: it is what a real row would have produced.

to
string

Empty when nothing was sent.