Send Email

Send a transactional email

The project is resolved from transactionalId, not just the URL - the URL's projectId must match the transactional email's own project, or this 404s.

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}/send-transactional

Request

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

Path parameters

projectIdstring required

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

Request body

emailstring required
transactionalIdstring required

A transactional email _id, from GET /v1/projectId/{projectId}/transactional-emails - NOT a template ID.

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.