Test Email

Send a test email

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).

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

Request

  • Base URL: https://api.bluefox.email
  • URL: https://api.bluefox.email/v1/projectId/{projectId}/test-email/{id}
  • Auth: HTTP bearer

Path parameters

projectIdstring required

The project _id, found in the app under Project Settings.

idstring required

The campaign/triggered-email/transactional-email _id.

Request body

type'campaign' | 'triggered' | 'transactional' required
emailstring

Required unless subscriberListId is given.

subscriberListIdstring

A private subscriber list to send to (picks a subscriber from it). Required unless email is given.

dataunknown

Response

OK, queued for sending

statusinteger

Example response

{
  "status": 200
}

Changes

No recorded changes to this operation across all 1 revision of this API.