Reference

You can also view the API documentation in Postman.

Send Email

POST https://api.encharge.io/v1/emails/send

Send transactional emails with Encharge.

Query Parameters

Name	Type	Description
token	string	Your Encharge API key.

Request Body

Name	Type	Description
template	string	The name of the email template to use. Only one of `text`, `html` or `template` may be set.
html	string	The content of your HTML email. Only one of `text`, `html` or `template` may be set.
text	string	The content of your plain-text email. Only one of `text`, `html` or `template` may be set.
to	string	Email address of the recipient. If the person has been previously created in Encharge, you can pass an object with `userId` and we'll use the email we have for this user.
from	string	Email address of the sender. If you'd like to set the sender name, pass an object with `email` and `name`. If a template is specified, this will overwrite the sender details in the template.
templateProperties	object	Dictionary of properties to be replaced in the email. For example, passing {"loginURL":"https://app.encharge.io/login/3n2l3ad99"} will replace `{{ loginURL }}` in the email body or subject.
unsubscribeCheck	boolean	By default, we will not send to people who have unsubscribed from your emails. Using caution, you can send to unsubscribed people by setting this flag to `false`.
UTMTags	boolean	If you've enabled Automatic UTM tagging in your Encharge account, we will tag all links in your emails. To disable this behavior, set this flag to `false`.
cc	String	Email addresses to CC in the current email. Multiple addresses can be passed as a comma-separated string.
bcc	String	Email addresses to BCC in the current email. Multiple addresses can be passed as a comma-separated string.
reply	String	Email address to reply to. Uses the from address if unspecified. If you'd like to set the reply name, pass an object with `email` and `name`. If a template is specified, this will overwrite the sender details in the template.

200

400

{
    "error": {
        "message": "Missing email content. Please pass `template`, `html` or `text`",
        "stack": "Error: \n    at new APIException (/home/slav/code/monorepo/packages/domain/exceptions/api_exceptions.ts:34:18)\n    at new BadRequestException (/home/slav/code/monorepo/packages/domain/lib/exceptions/api_exceptions.js:22:9)\n    at Function.getTemplate (/home/slav/code/monorepo/packages/api/src/services/TransactionalEmailService.ts:153:15)",
        "markdown": "<p>Missing email content. Please pass <code>template</code>, <code>html</code> or <code>text</code></p>\n",
        "traceId": "9751fe70-0957-11eb-a6b8-3baf67de29f8"
    }
}