Send a Quick Email
curl --request POST \
--url https://api.lumisreach.com/api/v1/quick/emails \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"to": [
"<string>"
],
"subject": "<string>",
"body": "<string>",
"reply_to": "<string>",
"from_name": "<string>"
}
'import requests
url = "https://api.lumisreach.com/api/v1/quick/emails"
payload = {
"to": ["<string>"],
"subject": "<string>",
"body": "<string>",
"reply_to": "<string>",
"from_name": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
to: ['<string>'],
subject: '<string>',
body: JSON.stringify('<string>'),
reply_to: '<string>',
from_name: '<string>'
})
};
fetch('https://api.lumisreach.com/api/v1/quick/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.lumisreach.com/api/v1/quick/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([
'to' => [
'<string>'
],
'subject' => '<string>',
'body' => '<string>',
'reply_to' => '<string>',
'from_name' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.lumisreach.com/api/v1/quick/emails"
payload := strings.NewReader("{\n \"to\": [\n \"<string>\"\n ],\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"reply_to\": \"<string>\",\n \"from_name\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.lumisreach.com/api/v1/quick/emails")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"to\": [\n \"<string>\"\n ],\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"reply_to\": \"<string>\",\n \"from_name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.lumisreach.com/api/v1/quick/emails")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"to\": [\n \"<string>\"\n ],\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"reply_to\": \"<string>\",\n \"from_name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "email",
"status": "sent",
"from": "<string>",
"reply_to": "<string>",
"sent_to": [
"<string>"
],
"suppressed": [
"<string>"
],
"recipients": [
{
"input": "<string>",
"email": "<string>",
"contact_id": "<string>",
"contact_name": "<string>"
}
],
"cost_usd": 123,
"pricing": {
"per_recipient_usd": 123,
"note": "<string>"
}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"fields": {},
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"fields": {},
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"fields": {},
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"fields": {},
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"fields": {},
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"fields": {},
"doc_url": "<string>"
}
}Quick Agent Actions
Send a Quick Email
Sends one plain-text email to up to 20 recipients (each gets an individual copy). Each `to` entry is an email address or the name of a contact in the workspace, matched case-insensitively with small typos tolerated, whose email on file is used; a name that matches no one returns 404, and one that could be two people returns 422 listing the candidates. It goes out from a shared LumisReach address, shown as "<from_name or workspace name> via LumisReach". No sending domain is required. Replies go to `reply_to`, defaulting to the email of the user who owns the API key. Recipients on the workspace's suppression list (unsubscribes, bounces) are skipped and reported in `suppressed`. Limited to 200 recipients per workspace per rolling 24 hours (409 past it); for bulk or marketing email use your own verified domain. Billing: $0.01 per recipient sent to, charged to the wallet of the organization that owns the API key; 403 when the wallet cannot cover it.
POST
/
v1
/
quick
/
emails
Send a Quick Email
curl --request POST \
--url https://api.lumisreach.com/api/v1/quick/emails \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"to": [
"<string>"
],
"subject": "<string>",
"body": "<string>",
"reply_to": "<string>",
"from_name": "<string>"
}
'import requests
url = "https://api.lumisreach.com/api/v1/quick/emails"
payload = {
"to": ["<string>"],
"subject": "<string>",
"body": "<string>",
"reply_to": "<string>",
"from_name": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
to: ['<string>'],
subject: '<string>',
body: JSON.stringify('<string>'),
reply_to: '<string>',
from_name: '<string>'
})
};
fetch('https://api.lumisreach.com/api/v1/quick/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.lumisreach.com/api/v1/quick/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([
'to' => [
'<string>'
],
'subject' => '<string>',
'body' => '<string>',
'reply_to' => '<string>',
'from_name' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.lumisreach.com/api/v1/quick/emails"
payload := strings.NewReader("{\n \"to\": [\n \"<string>\"\n ],\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"reply_to\": \"<string>\",\n \"from_name\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.lumisreach.com/api/v1/quick/emails")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"to\": [\n \"<string>\"\n ],\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"reply_to\": \"<string>\",\n \"from_name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.lumisreach.com/api/v1/quick/emails")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"to\": [\n \"<string>\"\n ],\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"reply_to\": \"<string>\",\n \"from_name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "email",
"status": "sent",
"from": "<string>",
"reply_to": "<string>",
"sent_to": [
"<string>"
],
"suppressed": [
"<string>"
],
"recipients": [
{
"input": "<string>",
"email": "<string>",
"contact_id": "<string>",
"contact_name": "<string>"
}
],
"cost_usd": 123,
"pricing": {
"per_recipient_usd": 123,
"note": "<string>"
}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"fields": {},
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"fields": {},
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"fields": {},
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"fields": {},
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"fields": {},
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"fields": {},
"doc_url": "<string>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
A UUID. When present, deduplicates repeat submissions. See /api-reference/idempotency.
Body
application/json
Recipients: email addresses and/or names of contacts in the workspace (case-insensitive, small typos are fine; the contact's email on file is used). Each gets an individual copy; they do not see each other
Required array length:
1 - 20 elementsRequired string length:
1 - 254Required string length:
1 - 200Required string length:
1 - 20000Maximum string length:
254Pattern:
^[^\s@<>(),;:"]+@[^\s@<>(),;:"]+\.[a-z]{2,}$Required string length:
1 - 60Response
Success
Show child attributes
Show child attributes