Test Email

Full reference for the Test Email resource in the bluefox.email API. See the API overview for authentication, the response envelope, and pagination.

Send a test email

POST /v1/projectId/{projectId}/test-email/{id}

Sends a campaign, triggered, or transactional email to a single recipient (by email or by picking a contact from a private subscriber list) without affecting real send stats or contact state.

Sending fails with a 405 if the account is out of email credit ("Insufficient credits available") - there is no public endpoint to check remaining balance ahead of time, only in the app. It also fails with a 405 if a sandbox project's daily send cap is exceeded, or if bounce/complaint rates have triggered automatic restriction (see Project.status and GET .../sandbox/deliverability).

Parameters

Name	In	Type	Required	Description
projectId	path	string	yes	The project _id, found in the app under Project Settings.
id	path	string	yes	The campaign/triggered-email/transactional-email _id.

Request body

Field	Type	Required	Description
type	string (campaign | triggered | transactional)	yes
email	string		Required unless subscriberListId is given.
subscriberListId	string		A private subscriber list to send to (picks a subscriber from it). Required unless email is given.
data	any		Template variables to render into the email.

Responses

Status	Description
200	OK, queued for sending
400	Invalid request body or query - every violation found (missing/invalid/unexpected fields) is reported in one response, semicolon-separated, not just the first one hit.
403	Missing or invalid API key
405	The operation is blocked by a business rule (e.g. the resource is still in use)

Response body

Field	Type	Required	Description
success	boolean