Skip to main content
POST
Send a one-off test email for a campaign to a specific address.

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Path Parameters

campaignId
string
required

Body

application/json

Test email target

Request body for sending a one-off test email

testEmail
string
required

Email address to send the test to

bodyHtml
string

Override HTML body to test with the current (unsaved) form value instead of the persisted campaign body

replyTo
string

Override reply-to address to test with the current (unsaved) form value

senderProfileId
string

Override sender profile to test with the current (unsaved) form selection instead of the persisted campaign sender

subject
string

Override subject to test with the current (unsaved) form value instead of the persisted campaign subject

Response

Result of the test send

Result of sending a test email

error
string

Error message when success is false

message
string

Provider message, when available

success
boolean

Whether the test email was accepted by the provider