Emails
Send an email
Send an email from a provisioned address to a customer, owner, or raw email address.
POST
/
v1
/
emails
Send an email
curl --request POST \
--url https://api.yorlet.com/v1/emails \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"subject": "<string>",
"body": "<string>",
"from": "<string>",
"to": "<string>",
"customer": "<string>",
"owner": "<string>",
"template": "plain",
"cc": [
"<string>"
],
"reply_to": "<string>",
"thread": "<string>",
"attachments": [
{
"id": "<string>",
"name": "<string>"
}
]
}
'import requests
url = "https://api.yorlet.com/v1/emails"
payload = {
"subject": "<string>",
"body": "<string>",
"from": "<string>",
"to": "<string>",
"customer": "<string>",
"owner": "<string>",
"template": "plain",
"cc": ["<string>"],
"reply_to": "<string>",
"thread": "<string>",
"attachments": [
{
"id": "<string>",
"name": "<string>"
}
]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
subject: '<string>',
body: JSON.stringify('<string>'),
from: '<string>',
to: '<string>',
customer: '<string>',
owner: '<string>',
template: 'plain',
cc: ['<string>'],
reply_to: '<string>',
thread: '<string>',
attachments: [{id: '<string>', name: '<string>'}]
})
};
fetch('https://api.yorlet.com/v1/emails', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.yorlet.com/v1/emails",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'subject' => '<string>',
'body' => '<string>',
'from' => '<string>',
'to' => '<string>',
'customer' => '<string>',
'owner' => '<string>',
'template' => 'plain',
'cc' => [
'<string>'
],
'reply_to' => '<string>',
'thread' => '<string>',
'attachments' => [
[
'id' => '<string>',
'name' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <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;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.yorlet.com/v1/emails"
payload := strings.NewReader("{\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"customer\": \"<string>\",\n \"owner\": \"<string>\",\n \"template\": \"plain\",\n \"cc\": [\n \"<string>\"\n ],\n \"reply_to\": \"<string>\",\n \"thread\": \"<string>\",\n \"attachments\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.yorlet.com/v1/emails")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"customer\": \"<string>\",\n \"owner\": \"<string>\",\n \"template\": \"plain\",\n \"cc\": [\n \"<string>\"\n ],\n \"reply_to\": \"<string>\",\n \"thread\": \"<string>\",\n \"attachments\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/emails")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"customer\": \"<string>\",\n \"owner\": \"<string>\",\n \"template\": \"plain\",\n \"cc\": [\n \"<string>\"\n ],\n \"reply_to\": \"<string>\",\n \"thread\": \"<string>\",\n \"attachments\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"created": 123,
"object": "message",
"actor": {
"type": "user",
"user": "<string>",
"key": "<string>"
},
"body": "<string>",
"channel": "email",
"direction": "inbound",
"thread": "<string>",
"account": "<string>",
"deleted": false,
"email": {
"attachments": [
{
"id": "<string>",
"filename": "<string>",
"content_type": "<string>"
}
],
"cc": [
"<string>"
],
"email_record_id": "<string>",
"from": "<string>",
"html": "<string>",
"in_reply_to": "<string>",
"message_id": "<string>",
"subject": "<string>",
"to": [
"<string>"
]
}
}Body
application/json
The email template. plain sends a text-only email. branded wraps the body in the account’s branded HTML template (logo, colours, support details). Defaults to plain. Prefer branded for standalone official outbound; keep plain for thread replies.
Available options:
plain, branded Response
200 - application/json
Returns the message object if the send succeeded.
Was this page helpful?
Send an email
curl --request POST \
--url https://api.yorlet.com/v1/emails \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"subject": "<string>",
"body": "<string>",
"from": "<string>",
"to": "<string>",
"customer": "<string>",
"owner": "<string>",
"template": "plain",
"cc": [
"<string>"
],
"reply_to": "<string>",
"thread": "<string>",
"attachments": [
{
"id": "<string>",
"name": "<string>"
}
]
}
'import requests
url = "https://api.yorlet.com/v1/emails"
payload = {
"subject": "<string>",
"body": "<string>",
"from": "<string>",
"to": "<string>",
"customer": "<string>",
"owner": "<string>",
"template": "plain",
"cc": ["<string>"],
"reply_to": "<string>",
"thread": "<string>",
"attachments": [
{
"id": "<string>",
"name": "<string>"
}
]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
subject: '<string>',
body: JSON.stringify('<string>'),
from: '<string>',
to: '<string>',
customer: '<string>',
owner: '<string>',
template: 'plain',
cc: ['<string>'],
reply_to: '<string>',
thread: '<string>',
attachments: [{id: '<string>', name: '<string>'}]
})
};
fetch('https://api.yorlet.com/v1/emails', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.yorlet.com/v1/emails",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'subject' => '<string>',
'body' => '<string>',
'from' => '<string>',
'to' => '<string>',
'customer' => '<string>',
'owner' => '<string>',
'template' => 'plain',
'cc' => [
'<string>'
],
'reply_to' => '<string>',
'thread' => '<string>',
'attachments' => [
[
'id' => '<string>',
'name' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <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;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.yorlet.com/v1/emails"
payload := strings.NewReader("{\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"customer\": \"<string>\",\n \"owner\": \"<string>\",\n \"template\": \"plain\",\n \"cc\": [\n \"<string>\"\n ],\n \"reply_to\": \"<string>\",\n \"thread\": \"<string>\",\n \"attachments\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.yorlet.com/v1/emails")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"customer\": \"<string>\",\n \"owner\": \"<string>\",\n \"template\": \"plain\",\n \"cc\": [\n \"<string>\"\n ],\n \"reply_to\": \"<string>\",\n \"thread\": \"<string>\",\n \"attachments\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/emails")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"customer\": \"<string>\",\n \"owner\": \"<string>\",\n \"template\": \"plain\",\n \"cc\": [\n \"<string>\"\n ],\n \"reply_to\": \"<string>\",\n \"thread\": \"<string>\",\n \"attachments\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"created": 123,
"object": "message",
"actor": {
"type": "user",
"user": "<string>",
"key": "<string>"
},
"body": "<string>",
"channel": "email",
"direction": "inbound",
"thread": "<string>",
"account": "<string>",
"deleted": false,
"email": {
"attachments": [
{
"id": "<string>",
"filename": "<string>",
"content_type": "<string>"
}
],
"cc": [
"<string>"
],
"email_record_id": "<string>",
"from": "<string>",
"html": "<string>",
"in_reply_to": "<string>",
"message_id": "<string>",
"subject": "<string>",
"to": [
"<string>"
]
}
}