Triggered Emails

Create a triggered email

subscriberListId must belong to this same project - a valid ID from a different project 404s.

post/v1/projectId/{projectId}/triggered-emails

Request

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

Path parameters

projectIdstring required

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

Request body

namestring required
subscriberListIdstring required

Required. If the user hasn't told you which list this triggered email is for, call GET /v1/projectId/{projectId}/subscriber-lists first and ask them to choose from the real list names - don't ask them for a raw ID.

excludeUnengagedboolean
subjectstring required
previewTextstring

Optional, but meaningfully affects open rates - if the user hasn't given you one, ask what they'd like it to say rather than leaving it blank.

senderIdentitystring

A sender identity _id. If the user hasn't told you which one to use, call GET /v1/projectId/{projectId}/sender-identities first and ask them to choose from the real email addresses returned - don't ask them for a raw ID.

replyTostring
type'html' | 'text'

Omit to keep using the visual (Chamaileon) editor document. Set to "html" or "text" to author document as a raw Handlebars template string instead (see the document field).

documentunknown

Response

Created

statusinteger

Example response

{
  "status": 200
}

Changes

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