Skip to main content
POST
Send a test email

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

Optional. A unique key you generate (max 255 chars, such as a UUID) that makes this request safe to retry. Retrying with the same key replays the original response instead of repeating the operation. Reusing a key with a different body returns 422.

Maximum string length: 255
Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Path Parameters

id
string<uuid>
required
Example:

"a7d4e2f1-08b3-4c65-9e7a-1b2c3d4e5f60"

Body

application/json
variantId
string<uuid>
required

The step variant to render. Take it from the campaign detail view.

Example:

"550e8400-e29b-41d4-a716-446655440000"

accountId
string<uuid>
required

The mailbox to send from. It must be one of yours and within its daily limit.

Example:

"3f1c2b7e-9a4d-4e18-b2c1-6d8f5a0e7c93"

recipient
string
required

Where to send the test. A single address. It is refused if the address, or its domain, is on your blacklist.

personalization
enum<string>
required

Where merge variables come from. dummy fills placeholders. lead uses a real lead, named by leadId. There is no fallback: lead without leadId is rejected.

Available options:
dummy,
lead
Example:

"dummy"

leadId
string<uuid>

The lead whose data fills the merge variables. Required when personalization is lead, and must be omitted otherwise.

Example:

"c9e5b1a3-7f24-4d80-a6b9-2e4f8c0d1a37"

Response

sent
boolean
required

The test email was handed to the mail server.

Example:

true

messageId
string | null
required

RFC 5322 Message-ID assigned by the sending server. null if the server did not return one.

Example: