logo
Documentation Powered by ReDoc

Email Messaging Service (v1.0)

Download OpenAPI specification:Download

This API is meant to provide a centralized email messaging service to our core business and other desired integrations.

For now there's only possible endpoint POST /sendMessage which is documented later on the page.

Errors

All of the error handling of this API is done with status codes and error messages according to the following structure:

{
  "error": "Missing parameters"
}

Versioning

This documentation regards version v1.0 of the Email Messaging Service.

Authentication

Authentication for registries is handled client side. The client has to send authentication details on all calls. The required authorization key must be sent as Authorization header as string with the following structure:

  "Authorization": "string",

Callback

In case of providing a callback , the returned params will be always {}

Send Email

Email payload request, in posession of that information this service can actually do the heavy-lifting for you.

busDelivery (Deprecated)

The endpoint POST/busDelivery has been deprecated, now should be used only the endpoint POST/sendMessage.

Responses

Send an email

header Parameters
Authorization
string <key>
Request Body schema: application/json

Email to send

from
required
string <email>

Email displayed as sender

to
required
string <email>

Target email

shouldPreserveMessage
boolean <boolean>
Default: false

Should save the message content on the log

subject
required
string

The subject of the email to be sent

message
required
string <html>

The actual content of the email to be sent in html, if a plain text is provided it will be trated as unstyled html

callback
string <url>

The callback endpoint you want our system to communicate in case of a failure or success

shouldSendConfirmationEmail
boolean <boolean>
Default: false

Should communicate by email in case of a failure or success (will only work in case a callbackEmail is provided)

callbackEmail
string <email>

An email for our servers to communicate in case of a failure or success (in only be used in case shouldSendConfirmationEmail is true)

Array of objects

A list of attachments can be sent

Responses

Request samples

Content type
application/json
{
  • "from": "test.email@email.com",
  • "to": "target.email@email.com",
  • "subject": "Policy change",
  • "message": "<div><text>hey, a policy change occurred</text><ul><li>a bullet point</li></ul></div>",
  • "shouldPreserveMessage": true,
  • "callback": "http://yourserver.com/callback",
  • "shouldSendConfirmationEmail": true,
  • "callbackEmail": "adebugging.email@email.com",
  • "attachments": [
    ]
}

Response samples

Content type
text/plain
e90e34656806