POST/emails/send/

Send an email

Email messages using API

From now on you can send email messages using our API. To do so, you'll need to set subject, content and receivers for the message. If you want to send your messages using specific settings, you should specify smtp id, or campaign id, otherwise we will use our default smtp to deliver your messages.

If you want to use content instead of template, just leave only the content attribute in payload. Using both attributes will in turn use template and ignore the content attribute.

HTML is allowed inside of email message content. For example, as a content we can set:

Hi <b>user</b>, enjoy our product!

The email message will be shown as follow:

Hi user, enjoy our product!

Attributes	Type	Required	Description
author	integer / string	yes	This can be an email (string) or ID (integer) of an author.
content	string	yes	A content of your email message.
receivers	integer	yes	A list of user ids separated by commas.
smtp/campaign	integer	no	A unique identifier of your SMTPSettings or Campaign automatically generated by User.com.
subject	string	yes	A subject of your email message.
template	integer	yes	An email template unique identifier.

ID for the receivers, can be found by requesting, single user details or by searching his email address.

Author can determine who's the sender of this email, it can be owner or any agent of the app.

Request

CURL
JavaScript
PHP
Python

 curl -X POST -H "Authorization: Token <your_64_char_api_key>"
     -H "Accept: */*; version=2" -H "Content-Type: application/json" -d '{
      "subject": "Email sent using API",
      "content": "This is content for email sent using API \<a href='\''http://example.org/'\''>link\</a>",
      "receivers": "5380718",
      "template": 1,
      "author": "johndoe@example.org"
  }' "https://<your_app_subdomain>.user.com/api/public/emails/send/"

var data = JSON.stringify({
  "subject": "Email sent using API",
  "content": "This is content for email sent using API \<a href='http://example.org/'>link\</a>",
  "receivers": "5380718",
  "template": 1,
  "author": "johndoe@example.org"
});

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://<your_app_subdomain>.user.com/api/public/emails/send/");
xhr.setRequestHeader("authorization", "Token <your_64_char_api_key>");
xhr.setRequestHeader("accept", "*/*; version=2");
xhr.setRequestHeader("content-type", "application/json");

xhr.send(data);

<?php
    
$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://<your_app_subdomain>.user.com/api/public/emails/send/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\n    \"subject\": \"Email sent using API\",\n    \"content\": \"This is content for email sent using API \<a href='http://example.org/'>link\</a>\",\n    \"receivers\": \"5380718\",\n    \"template\": 1,\n    \"author\": \"johndoe@example.org\"\n}",
  CURLOPT_HTTPHEADER => array(
      "Accept: */*; version=2",
    "authorization: Token <your_64_char_api_key>",
    "content-type: application/json"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import http.client
    
conn = http.client.HTTPSConnection("<your_app_subdomain>.user.com")

payload = "{\n    \"subject\": \"Email sent using API\",\n    \"content\": \"This is content for email sent using API \<a href='http://example.org/'>link\</a>\",\n    \"receivers\": \"5380718\",\n    \"template\": 1,\n    \"author\": \"johndoe@example.org\"\n}"

headers = {
    'authorization': "Token <your_64_char_api_key>",
     'Accept': "*/*; version=2",
    'content-type': "application/json"
    }

conn.request("POST", "/api/public/emails/send/", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Response

{
  "campaign": 880
}

This response means that the email has been sent correctly.

Request​

Response​

Request

Response