Skip to main content
POST
/
email
/
transactional
Sends an email to specified email address.
curl --request POST \
  --url https://api.indiepitcher.com/v1/email/transactional \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "subject": "You've been invited to IndiePitcher",
  "body": "You can use **markdown** to generate the email. Plain HTML is also supported.",
  "bodyFormat": "markdown",
  "to": "[email protected]",
  "trackEmailOpens": null,
  "trackEmailLinkClicks": null
}
EOF
{
  "success": true
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
subject
string
required

The subject of the email.

Example:

"You've been invited to IndiePitcher"

​
body
string
required

The body of the email. Supports markdown and HTML

Example:

"You can use **markdown** to generate the email. Plain HTML is also supported."

​
bodyFormat
enum<string>
required

The format of the email body. It can be either 'markdown' or 'html'.

Available options:
markdown,
html
​
to
string

Can be just an email "[email protected]", or an email with a neme "John Doe [email protected]"

Example:

"[email protected]"

​
trackEmailOpens
boolean

Whether to track email opens. Allow you to overwrite the project's global setting. Default: nil - Uses the project's global setting.

Example:

null

​
trackEmailLinkClicks
boolean

Whether to track when a users taps on a link in the email. Allow you to overwrite the project's global setting. Default: nil - Uses the project's global setting.

Example:

null

Response

200 - application/json

An empty response

​
success
boolean

Always true