Skip to main content
POST
Send a test email

Authorizations

Authorization
string
header
required

A session token from subscriber login, used by subscriber.dev's own apps. Requests about an environment also need its ID in the x-environment-id header. From your own code, use an API key.

Body

application/json
subject
string
Maximum string length: 500
body
string
layout
enum<string>
default:default
Available options:
default,
none
previewText
string

Short summary inboxes show next to the subject. Supports Liquid. Only used with the default layout.

Maximum string length: 255
fromName
string

Sender name for every email in this workflow, e.g. "Jane from Acme". Defaults to the email integration's fromName. The from address always comes from the integration.

Maximum string length: 255
replyTo
string<email>

Where replies to this workflow's emails go. Defaults to the email integration's replyTo, or the from address.

Pattern: ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
workflowId
string

Send one of this workflow's email steps, as it stands now, instead of a subject and body.

step
integer

Which of the workflow's steps to send, counting from 1. Defaults to its first email step.

Required range: 1 <= x <= 9007199254740991
to
string<email>

Who to send it to. Defaults to your own address.

Pattern: ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
data
object

Sample data for the template, like a trigger payload: {"plan": "pro"} is {{ plan }}. Put subscriber fields under "subscriber", e.g. {"subscriber": {"firstName": "Ada"}}. Defaults to your own details as the subscriber.

Response

to
string
required
subject
string
required