POST/emails/send-custom-domain/

Send email messages with custom domain

This endpoint allows you to send email messages using your custom domain settings. You need a custom domain settings ID (which you can get from Email settings) and optionally a custom sender ID (from Sender settings).

HTML is allowed within email message content. For example, you can set the content as:

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

The email message will be displayed as:

Hi user, enjoy our product!

Attribute	Type	Required	Description
api_email_settings/campaign	integer	no	The unique identifier of your custom domain settings or campaign automatically generated by User.com.
author	integer / string	yes	The unique identifier of an email author (string) or author ID (integer).
content	string	yes	The content of your email message (HTML allowed).
custom_sender	integer	no	The unique identifier of your custom sender (optional).
receivers	string	yes	A comma-separated list of user IDs.
subject	string	yes	The subject line for your email message.
template	integer	no	The unique identifier of the email template.

If you want to use an existing email campaign, pass your email campaign ID as the value in the request body. Note that your email campaign must be active.

The author parameter determines who appears as the sender of this email - it can be the 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 '{
    "api_email_settings": 123,
    "custom_sender": 456,
    "subject": "Welcome to Our Platform",
    "content": "Hello! Welcome to our platform. \<a href='\''https://example.com/dashboard'\''>Access your dashboard\</a>",
    "receivers": "1001,1002,1003",
    "template": 789,
    "author": "support@yourcompany.com"
}' "https://<your_app_subdomain>.user.com/api/public/emails/send-custom-domain/"

var data = JSON.stringify({
  "api_email_settings": "1",
  "custom_sender": "1",
  "subject": "Email sent using API",
  "content": "Hello! Welcome to our platform. \<a href='https://example.com/dashboard'>Access your dashboard\</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-custom-domain/");
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-custom-domain/",
  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    \"api_email_settings\": \"1\",\n    \"custom_sender\": \"1\",\n    \"subject\": \"Email sent using API\",\n    \"content\": \"Hello! Welcome to our platform. \<a href='https://example.com/dashboard'>Access your dashboard\</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    \"api_email_settings\": \"1\",\n    \"custom_sender\": \"1\",\n    \"subject\": \"Email sent using API\",\n    \"content\": \"Hello! Welcome to our platform. \<a href='https://example.com/dashboard'>Access your dashboard\</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-custom-domain/", payload, headers)

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

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

Response

{
  "campaign": 880
}

This response indicates that the email has been sent successfully. The returned value is the email campaign ID that was created for this send operation.

Request​

Response​

Request

Response