Send Email Transactional

Caution

For security reasons, please contact your Account Manager to provide you with an API host.

The host https://api.example.com not is a real endpoint.

POST

/v1/send/email

Sends an email using the provided JSON body.

This method is suitable for production usage and allows for more complex email configurations.

Authorizations

BearerAuth

Use HTTP Bearer Authentication to authorize requests.

Provide your API token as a Bearer token in the Authorization header.

Example: Authorization: Bearer YOUR_API_TOKEN_HERE

(Replace “YOUR_API_TOKEN_HERE” with your actual API token.)

Request Body

The request body for sending an email.

This request body should be a JSON object containing the necessary fields to send an email.

object

from

required

object

name

The name of the sender.

string

John Doe

email

The email address of the sender.

string format: email

john@doe.com

to

required

Array<object>

object

name

The name of the recipient.

string

Jane Smith

email

The email address of the recipient.

string format: email

jane@smith.com

subject

required

The subject of the email.

string

Welcome to Our Service

text

required

The content of the email.

string

Hello, this is a test email.

html

required

The HTML content of the email.

string

<p>Hello, this is a test email.</p>

variables

Variables to be used in the email template. Variables avalaible from A to Z. You can define variables like variable_a_var, variable_b_var, etc.

These variables can be used in dynamic content like {{variable_a_var}}.

object

variable_a_var

Use on dynamic content like {{variable_a_var}}.

string

Variable A Value

attachment

A list of files to be attached to the email.

Each file can be specified by its name and URL
(Max size allowed 10MB).

Array<object>

object

name

The name of the file to be attached.

string

document.pdf

url

The URL of the file to be attached.

The file will be downloaded and attached to the email.

string format: url

https://www.buildquickbots.com/whatsapp/media/sample/pdf/sample01.pdf

attachment_buffer

A list of files to be attached to the email.

Each file can be specified by its name and base64 encoded content
(Max size allowed 10MB).

Array<object>

object

name

The name of the file to be attached.

string

document.pdf

content

The base64 encoded content of the file to be attached.

This is useful for small files that can be sent directly in the request.

string format: byte

data:(mime type),base64,JVBERi0xLjQKJazc... (base64 content)

Responses

200

Email sent successfully.

object

status

boolean

true

message

string

Email sent successfully

data

A list of sent email identifiers.

Array

401

Your key auth is not valid

object

status

boolean

error

boolean

true

message

string

Your key auth is not valid, please check with your administrator to get the new key

Example

{
  "status": false,
  "error": true,
  "description": "Your key auth is not valid, please check with your administrator to get the new key"
}

402

Your account dont have credits availables for send

object

status

boolean

error

boolean

true

message

string

Your account dont have credits availables for send this, please contact your administrator

Example

{
  "status": false,
  "error": true,
  "description": "Your account dont have credits availables for send this, please contact your administrator"
}

422

Missing required parameters

object

status

boolean

error

boolean

true

message

string

Missing params, please verify or contact to support

Example

{
  "status": false,
  "error": true,
  "description": "Missing params, please verify or contact to support"
}

Examples

Useful for guiding users to view code examples in different developer languages.

Bash

developer@developer:~#

curl -X POST "https://api.example.com/v1/send/email" \
    -H "Accept: application/json" \
  -H "Connection: keep-alive" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-token>" \
  -d '{"from":{"name":"John Doe","email":"john@doe.com"},"to":[{"name":"Jane Smith","email":"jane@smith.com"}],"subject":"Welcome to Our Service","text":"Hello, this is a test email.","html":"<p>Hello, this is a test email.</p>","variables":{"variable_a_var":"Variable A Value"},"attachment":[{"name":"document.pdf","url":"https://www.buildquickbots.com/whatsapp/media/sample/pdf/sample01.pdf"}],"attachment_buffer":[{"name":"document.pdf","content":"data:(mime type),base64,JVBERi0xLjQKJazc... (base64 content)"}]}'

Node.js

example.js

  const fetch = require('node-fetch');

  fetch("https://api.example.com/v1/send/email", {
    method: "POST",
    headers: {
  "Accept": "application/json",
  "Connection": "keep-alive",
  "Content-Type": "application/json",
  "Authorization": "Bearer <your-token>"
},
    body: JSON.stringify({
  "from": {
    "name": "John Doe",
    "email": "john@doe.com"
  },
  "to": [
    {
      "name": "Jane Smith",
      "email": "jane@smith.com"
    }
  ],
  "subject": "Welcome to Our Service",
  "text": "Hello, this is a test email.",
  "html": "<p>Hello, this is a test email.</p>",
  "variables": {
    "variable_a_var": "Variable A Value"
  },
  "attachment": [
    {
      "name": "document.pdf",
      "url": "https://www.buildquickbots.com/whatsapp/media/sample/pdf/sample01.pdf"
    }
  ],
  "attachment_buffer": [
    {
      "name": "document.pdf",
      "content": "data:(mime type),base64,JVBERi0xLjQKJazc... (base64 content)"
    }
  ]
})
  })
    .then(res => res.json())
    .then(console.log)
    .catch(console.error);

PHP

example.php

  <?php
  $curl = curl_init();

  curl_setopt_array($curl, [
    CURLOPT_URL => "https://api.example.com/v1/send/email",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Connection: keep-alive",
    "Content-Type: application/json",
    "Authorization: Bearer <your-token>"
    ],
    CURLOPT_POSTFIELDS => json_encode({
  "from": {
    "name": "John Doe",
    "email": "john@doe.com"
  },
  "to": [
    {
      "name": "Jane Smith",
      "email": "jane@smith.com"
    }
  ],
  "subject": "Welcome to Our Service",
  "text": "Hello, this is a test email.",
  "html": "<p>Hello, this is a test email.</p>",
  "variables": {
    "variable_a_var": "Variable A Value"
  },
  "attachment": [
    {
      "name": "document.pdf",
      "url": "https://www.buildquickbots.com/whatsapp/media/sample/pdf/sample01.pdf"
    }
  ],
  "attachment_buffer": [
    {
      "name": "document.pdf",
      "content": "data:(mime type),base64,JVBERi0xLjQKJazc... (base64 content)"
    }
  ]
})
  ]);

  $response = curl_exec($curl);
  curl_close($curl);
  echo $response;
  ?>

C-Sharp

example.cs

  using System.Net.Http;
  using System.Text;
  using System.Threading.Tasks;

  var client = new HttpClient();
  var request = new HttpRequestMessage(HttpMethod.POST, "https://api.example.com/v1/send/email") {
    Content = new StringContent("{
  \"from\": {
    \"name\": \"John Doe\",
    \"email\": \"john@doe.com\"
  },
  \"to\": [
    {
      \"name\": \"Jane Smith\",
      \"email\": \"jane@smith.com\"
    }
  ],
  \"subject\": \"Welcome to Our Service\",
  \"text\": \"Hello, this is a test email.\",
  \"html\": \"<p>Hello, this is a test email.</p>\",
  \"variables\": {
    \"variable_a_var\": \"Variable A Value\"
  },
  \"attachment\": [
    {
      \"name\": \"document.pdf\",
      \"url\": \"https://www.buildquickbots.com/whatsapp/media/sample/pdf/sample01.pdf\"
    }
  ],
  \"attachment_buffer\": [
    {
      \"name\": \"document.pdf\",
      \"content\": \"data:(mime type),base64,JVBERi0xLjQKJazc... (base64 content)\"
    }
  ]
}", Encoding.UTF8, "application/json")
  };
  request.Headers.Add("Accept", "application/json");
request.Headers.Add("Connection", "keep-alive");
request.Headers.Add("Content-Type", "application/json");
request.Headers.Add("Authorization", "Bearer <your-token>");
  var response = await client.SendAsync(request);
  var responseBody = await response.Content.ReadAsStringAsync();
  Console.WriteLine(responseBody);

Python

example.py

  import requests
  import json

  url = "https://api.example.com/v1/send/email"
  headers = {
    "Accept": "application/json",
  "Connection": "keep-alive",
  "Content-Type": "application/json",
  "Authorization": "Bearer <your-token>"
  }
  data = {
  "from": {
    "name": "John Doe",
    "email": "john@doe.com"
  },
  "to": [
    {
      "name": "Jane Smith",
      "email": "jane@smith.com"
    }
  ],
  "subject": "Welcome to Our Service",
  "text": "Hello, this is a test email.",
  "html": "<p>Hello, this is a test email.</p>",
  "variables": {
    "variable_a_var": "Variable A Value"
  },
  "attachment": [
    {
      "name": "document.pdf",
      "url": "https://www.buildquickbots.com/whatsapp/media/sample/pdf/sample01.pdf"
    }
  ],
  "attachment_buffer": [
    {
      "name": "document.pdf",
      "content": "data:(mime type),base64,JVBERi0xLjQKJazc... (base64 content)"
    }
  ]
}

  response = requests.post(url, headers=headers, json=data)
  print(response.text)

Java

example.java

  import java.io.OutputStream;
  import java.net.HttpURLConnection;
  import java.net.URL;
  import java.nio.charset.StandardCharsets;

  public class ApiExample {
    public static void main(String[] args) throws Exception {
      URL url = new URL("https://api.example.com/v1/send/email");
      HttpURLConnection conn = (HttpURLConnection) url.openConnection();
      conn.setRequestMethod("POST");
      conn.setDoOutput(true);
      conn.setRequestProperty("Accept", "application/json");
    conn.setRequestProperty("Connection", "keep-alive");
    conn.setRequestProperty("Content-Type", "application/json");
    conn.setRequestProperty("Authorization", "Bearer <your-token>");

      String jsonInputString = "{\"from\":{\"name\":\"John Doe\",\"email\":\"john@doe.com\"},\"to\":[{\"name\":\"Jane Smith\",\"email\":\"jane@smith.com\"}],\"subject\":\"Welcome to Our Service\",\"text\":\"Hello, this is a test email.\",\"html\":\"<p>Hello, this is a test email.</p>\",\"variables\":{\"variable_a_var\":\"Variable A Value\"},\"attachment\":[{\"name\":\"document.pdf\",\"url\":\"https://www.buildquickbots.com/whatsapp/media/sample/pdf/sample01.pdf\"}],\"attachment_buffer\":[{\"name\":\"document.pdf\",\"content\":\"data:(mime type),base64,JVBERi0xLjQKJazc... (base64 content)\"}]}";
      try(OutputStream os = conn.getOutputStream()) {
          byte[] input = jsonInputString.getBytes(StandardCharsets.UTF_8);
          os.write(input, 0, input.length);
      }

      int code = conn.getResponseCode();
      System.out.println("Response code: " + code);
    }
  }