Send email

POST

/api/v2/marketing/actions/send

Send a marketing email with your own HTML.

The emails provided must be current subscribers of the corresponding channel, or Letterhead will return a 400.

Your HTML must comply with all regional laws in addition to CANSPAM.

Remember that Gmail will “clip” an email that’s greater than 102kb. Letterhead won’t compress HTML you compose, so be sure to take its filesize in consideration.

Authorizations

bearerAuth

Request Body

multipart/form-data

object

channel

required | string The channel identifier (or “channel slug”) where the recipients of this email are subscribed.

string

Example

black-bitter-coffee-times

emails[]

required | array List of email addresses you wish to target.

Note: while “emails” implies a plurality, Letterhead presently accepts only one email address.

string

Example

[email protected]

html

required | string The raw, valid HTML body of your email, starting with its opening doctype. Your email must comply with CANSPAM.

string

Example

<html><head><title>Amazing Newsletter Survey</title></head><body><h1>How are you enjoying our newsletter?</h1><p>We're hoping you have some kind words to say.</p></body></html>

subject

required | string The email subject of the newsletter. Maximum 191 characters.

string

Example

Can we ask you a question?

Responses

200

Email successfully sent

application/octet-stream

Examples

Email successfully sent

"Your letter with given HTML is scheduled to publish in 5 minutes."

Headers

Access-Control-Allow-Credentials

string

Example

true

Access-Control-Allow-Origin

string

Example

Access-Control-Max-Age

string

Example

Cache-Control

string

Example

no-cache, private

Connection

string

Example

keep-alive

Date

string

Example

Mon, 26 Aug 2024 18:18:33 GMT

Server

string

Example

nginx/1.14.0 (Ubuntu)

Transfer-Encoding

string

Example

chunked

Still can’t find what you need? Contact support.