Send a test email

Send an email type to your own address (the user behind the token), with [Test] added to the subject. Content you send is used for this test only and isn't saved; anything you leave out comes from the saved template. Merge fields get their sample values.

Prerequisites: a bearer token, the account's id (company_id) and the email type from List email types. Your user needs an email address.

Authentication: Partner or Account token. company_id must be inside your own account tree (a Partner token reaches any account under the partner, an Account token only its own); otherwise 422. The account's partner must have the email templates section turned on; otherwise 403. Types managed centrally by the platform return 403. The test always goes to your own address (400 if you have none).

Rate limit: 60 requests per minute, counted per user (the token’s user).

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

The account. Must exist and be inside your account tree.

string
enum
required
Defaults to user_welcome

The email type, from List email types.

string

The header region. Base64-encoded HTML, up to 80,000 characters. Only merge fields from List an email's merge fields for this type are allowed. Left out: the saved version is used.

string
Defaults to PHA+SGVsbG8gW2N1c3RvbWVyTmFtZV08L3A+

The body region. Base64-encoded HTML, up to 80,000 characters. Only merge fields from List an email's merge fields for this type are allowed. Left out: the saved version is used.

string

The signature region. Base64-encoded HTML, up to 80,000 characters. Only merge fields from List an email's merge fields for this type are allowed. Left out: the saved version is used.

string
length ≤ 255
Defaults to Welcome to [partnerTitle]!

The subject, as plain text (not base64), up to 255 characters. Merge fields allowed. Left out: the saved subject is used.

string
enum
Defaults to regions

regions (header, body, footer and signature) or html (one full-HTML body in custom_html). Left out: the saved mode is used.

Allowed:
string

The full-HTML body for html mode, base64-encoded, up to 400,000 characters. Left out: the saved version is used.

Show (true) or hide (false) the logo for this test only. Left out: the saved setting is used.

Responses

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