👾 Transactional Email API

Welcome to the Emailflow API documentation! With our API, you can easily automate sending transactional emails and generating PDFs. This guide will cover everything you need to know to get started.

Base URL

All URLs referenced in the API documentation have the following base URL:

https://api.emailflow.so/v1

Authentication

To authenticate your API requests, you need to include a Bearer Token in your HTTP headers. The API key should be prefixed by the word Bearer followed by a space.

Authorization: Bearer API_KEY

Note: Replace API_KEY with your actual API key.

---

Sending Emails

POST https://api.emailflow.so/v1/email

Send transactional email.

Headers

Name	Type	Description
Authorization*	Bearer API_KEY

Request Body

Name	Type	Description
templateId*	String
to*	String
params	JSON

200: OK

400: Bad Request { "error": ERROR_MSG }

Endpoint

POST /email

Request Body Parameters

Parameter	Type	Description
templateId	string	The ID of the email template.
to	string	The email address to send to.
params	object	Any additional parameters needed.

Response

Upon successful request, you will receive:

{
  "success": true
}

Upon failure:

{
  "error": "Error message here."
}

---

We'll be adding example requests and additional guidelines soon. Stay tuned!

Thank you for using Emailflow!