POST /smtp/email

The POST /smtp/email endpoint is used to send an email via SMTP. The request should include the sender's information, recipient's information, email content, subject, reply-to information, and optional tags.

Request Body

Response

The response will contain a JSON object with the messageId field, which represents the unique identifier for the sent email.

Example Response Schema

{
  "type": "object",
  "properties": {
    "messageId": {
      "type": "string"
    }
  }
}

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Query parameters

Name Type Required Description
String No

Request body fields

Name Type Required Description
htmlContent String No
messageVersions[] Array No
messageVersions[].to[] Array No
messageVersions[].to[].email String No
messageVersions[].to[].name String No
messageVersions[].params Object No
messageVersions[].params.dolore__b Object No
messageVersions[].params.Lorem749 Object No
messageVersions[].cc[] Array No
messageVersions[].cc[].email String No
messageVersions[].cc[].name String No
messageVersions[].bcc[] Array No
messageVersions[].bcc[].email String No
messageVersions[].bcc[].name String No
messageVersions[].replyTo Object No
messageVersions[].replyTo.email String No
messageVersions[].replyTo.name String No
messageVersions[].subject String No
replyTo Object No
replyTo.email String No
replyTo.name String No
textContent String No
sender Object No
sender.id Number No
sender.email String No
sender.name String No
scheduledAt String No
subject String No
attachment[] Array No
attachment[].name String No
attachment[].url String No
attachment[].content String No
to[] Array No
to[].email String No
to[].name String No
params Object No
params.Utf08 Object No
batchId String No
templateId Number No
cc[] Array No
cc[].email String No
cc[].name String No
bcc[] Array No
bcc[].email String No
bcc[].name String No
tags[] Array No
headers Object No
headers.ut_86_ Object No

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.