Send a test email
Send yourself a rendered preview of one step variant before launching. It goes from a real mailbox and counts toward that mailbox’s daily limit, but not your monthly quota. Capped at 12 per day per workspace.
Requires one of the following scopes: campaigns:lifecycle, campaigns:all, all:all.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
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.
255"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
Path Parameters
"a7d4e2f1-08b3-4c65-9e7a-1b2c3d4e5f60"
Body
The step variant to render. Take it from the campaign detail view.
"550e8400-e29b-41d4-a716-446655440000"
The mailbox to send from. It must be one of yours and within its daily limit.
"3f1c2b7e-9a4d-4e18-b2c1-6d8f5a0e7c93"
Where to send the test. A single address. It is refused if the address, or its domain, is on your blacklist.
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.
dummy, lead "dummy"
The lead whose data fills the merge variables. Required when personalization is lead, and must be omitted otherwise.
"c9e5b1a3-7f24-4d80-a6b9-2e4f8c0d1a37"
Response
The test email was handed to the mail server.
true
RFC 5322 Message-ID assigned by the sending server. null if the server did not return one.