Emails
Send bulk email
Queues email to saved contacts matching filters.
filters must include at least one of lists, contactIds,
campaignIds, or a text query.
The audience is resolved before anything is queued. More than
500 matched contacts is a 400 — the send is not truncated.
Opted-out and unsubscribed contacts are skipped.
Does not consume public API credits.
Repeat a request with the same Idempotency-Key header (or
idempotencyKey body field) and the same body to replay the
original job. Reusing a key with a different audience or
message is a 422.
POST
/
emails
/
send-bulk
Send bulk email
curl --request POST \
--url https://api.seamless.ai/api/client/v2/emails/send-bulk \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"from": "<string>",
"filters": {
"contactIds": [
123
],
"lists": [
123
],
"queryText": "<string>",
"queryTextName": "<string>",
"queryTextCompany": "<string>",
"queryTextDomain": "<string>",
"queryTextTitle": "<string>",
"queryTextLocation": "<string>",
"industryFilters": [
"<string>"
],
"companyFilters": [
"<string>"
],
"seniorities": [
"<string>"
],
"departments": [
"<string>"
],
"prospectStatuses": [
"<string>"
],
"engagementStatuses": [
"<string>"
],
"employeeSizeFilters": [
"<string>"
],
"revenueFilters": [
"<string>"
],
"campaignIds": [
123
],
"technologies": [
"<string>"
]
},
"subject": "<string>",
"body": "<string>",
"templateId": 123,
"scheduleAt": "2023-11-07T05:31:56Z",
"idempotencyKey": "<string>"
}
'import requests
url = "https://api.seamless.ai/api/client/v2/emails/send-bulk"
payload = {
"from": "<string>",
"filters": {
"contactIds": [123],
"lists": [123],
"queryText": "<string>",
"queryTextName": "<string>",
"queryTextCompany": "<string>",
"queryTextDomain": "<string>",
"queryTextTitle": "<string>",
"queryTextLocation": "<string>",
"industryFilters": ["<string>"],
"companyFilters": ["<string>"],
"seniorities": ["<string>"],
"departments": ["<string>"],
"prospectStatuses": ["<string>"],
"engagementStatuses": ["<string>"],
"employeeSizeFilters": ["<string>"],
"revenueFilters": ["<string>"],
"campaignIds": [123],
"technologies": ["<string>"]
},
"subject": "<string>",
"body": "<string>",
"templateId": 123,
"scheduleAt": "2023-11-07T05:31:56Z",
"idempotencyKey": "<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({
from: '<string>',
filters: {
contactIds: [123],
lists: [123],
queryText: '<string>',
queryTextName: '<string>',
queryTextCompany: '<string>',
queryTextDomain: '<string>',
queryTextTitle: '<string>',
queryTextLocation: '<string>',
industryFilters: ['<string>'],
companyFilters: ['<string>'],
seniorities: ['<string>'],
departments: ['<string>'],
prospectStatuses: ['<string>'],
engagementStatuses: ['<string>'],
employeeSizeFilters: ['<string>'],
revenueFilters: ['<string>'],
campaignIds: [123],
technologies: ['<string>']
},
subject: '<string>',
body: JSON.stringify('<string>'),
templateId: 123,
scheduleAt: '2023-11-07T05:31:56Z',
idempotencyKey: '<string>'
})
};
fetch('https://api.seamless.ai/api/client/v2/emails/send-bulk', 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.seamless.ai/api/client/v2/emails/send-bulk",
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([
'from' => '<string>',
'filters' => [
'contactIds' => [
123
],
'lists' => [
123
],
'queryText' => '<string>',
'queryTextName' => '<string>',
'queryTextCompany' => '<string>',
'queryTextDomain' => '<string>',
'queryTextTitle' => '<string>',
'queryTextLocation' => '<string>',
'industryFilters' => [
'<string>'
],
'companyFilters' => [
'<string>'
],
'seniorities' => [
'<string>'
],
'departments' => [
'<string>'
],
'prospectStatuses' => [
'<string>'
],
'engagementStatuses' => [
'<string>'
],
'employeeSizeFilters' => [
'<string>'
],
'revenueFilters' => [
'<string>'
],
'campaignIds' => [
123
],
'technologies' => [
'<string>'
]
],
'subject' => '<string>',
'body' => '<string>',
'templateId' => 123,
'scheduleAt' => '2023-11-07T05:31:56Z',
'idempotencyKey' => '<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.seamless.ai/api/client/v2/emails/send-bulk"
payload := strings.NewReader("{\n \"from\": \"<string>\",\n \"filters\": {\n \"contactIds\": [\n 123\n ],\n \"lists\": [\n 123\n ],\n \"queryText\": \"<string>\",\n \"queryTextName\": \"<string>\",\n \"queryTextCompany\": \"<string>\",\n \"queryTextDomain\": \"<string>\",\n \"queryTextTitle\": \"<string>\",\n \"queryTextLocation\": \"<string>\",\n \"industryFilters\": [\n \"<string>\"\n ],\n \"companyFilters\": [\n \"<string>\"\n ],\n \"seniorities\": [\n \"<string>\"\n ],\n \"departments\": [\n \"<string>\"\n ],\n \"prospectStatuses\": [\n \"<string>\"\n ],\n \"engagementStatuses\": [\n \"<string>\"\n ],\n \"employeeSizeFilters\": [\n \"<string>\"\n ],\n \"revenueFilters\": [\n \"<string>\"\n ],\n \"campaignIds\": [\n 123\n ],\n \"technologies\": [\n \"<string>\"\n ]\n },\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"templateId\": 123,\n \"scheduleAt\": \"2023-11-07T05:31:56Z\",\n \"idempotencyKey\": \"<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.seamless.ai/api/client/v2/emails/send-bulk")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"from\": \"<string>\",\n \"filters\": {\n \"contactIds\": [\n 123\n ],\n \"lists\": [\n 123\n ],\n \"queryText\": \"<string>\",\n \"queryTextName\": \"<string>\",\n \"queryTextCompany\": \"<string>\",\n \"queryTextDomain\": \"<string>\",\n \"queryTextTitle\": \"<string>\",\n \"queryTextLocation\": \"<string>\",\n \"industryFilters\": [\n \"<string>\"\n ],\n \"companyFilters\": [\n \"<string>\"\n ],\n \"seniorities\": [\n \"<string>\"\n ],\n \"departments\": [\n \"<string>\"\n ],\n \"prospectStatuses\": [\n \"<string>\"\n ],\n \"engagementStatuses\": [\n \"<string>\"\n ],\n \"employeeSizeFilters\": [\n \"<string>\"\n ],\n \"revenueFilters\": [\n \"<string>\"\n ],\n \"campaignIds\": [\n 123\n ],\n \"technologies\": [\n \"<string>\"\n ]\n },\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"templateId\": 123,\n \"scheduleAt\": \"2023-11-07T05:31:56Z\",\n \"idempotencyKey\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.seamless.ai/api/client/v2/emails/send-bulk")
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 \"from\": \"<string>\",\n \"filters\": {\n \"contactIds\": [\n 123\n ],\n \"lists\": [\n 123\n ],\n \"queryText\": \"<string>\",\n \"queryTextName\": \"<string>\",\n \"queryTextCompany\": \"<string>\",\n \"queryTextDomain\": \"<string>\",\n \"queryTextTitle\": \"<string>\",\n \"queryTextLocation\": \"<string>\",\n \"industryFilters\": [\n \"<string>\"\n ],\n \"companyFilters\": [\n \"<string>\"\n ],\n \"seniorities\": [\n \"<string>\"\n ],\n \"departments\": [\n \"<string>\"\n ],\n \"prospectStatuses\": [\n \"<string>\"\n ],\n \"engagementStatuses\": [\n \"<string>\"\n ],\n \"employeeSizeFilters\": [\n \"<string>\"\n ],\n \"revenueFilters\": [\n \"<string>\"\n ],\n \"campaignIds\": [\n 123\n ],\n \"technologies\": [\n \"<string>\"\n ]\n },\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"templateId\": 123,\n \"scheduleAt\": \"2023-11-07T05:31:56Z\",\n \"idempotencyKey\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"jobId": 123,
"matched": 123,
"queued": 123,
"skipped": 123
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Authorizations
OAuth2ApiKeyAuth
The access token received from the authorization server in the OAuth 2.0 flow.
Headers
Retry token. Same key plus the same body replays the original job. Same key plus a different body is a 422.
Maximum string length:
255Body
application/json
Connected sender address.
Saved-contact filters. Unknown keys are rejected.
Must include at least one of lists, contactIds,
campaignIds, or a text query.
Show child attributes
Show child attributes
Required when templateId is omitted.
Required when templateId is omitted.
Maximum string length:
255Was this page helpful?
⌘I
Send bulk email
curl --request POST \
--url https://api.seamless.ai/api/client/v2/emails/send-bulk \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"from": "<string>",
"filters": {
"contactIds": [
123
],
"lists": [
123
],
"queryText": "<string>",
"queryTextName": "<string>",
"queryTextCompany": "<string>",
"queryTextDomain": "<string>",
"queryTextTitle": "<string>",
"queryTextLocation": "<string>",
"industryFilters": [
"<string>"
],
"companyFilters": [
"<string>"
],
"seniorities": [
"<string>"
],
"departments": [
"<string>"
],
"prospectStatuses": [
"<string>"
],
"engagementStatuses": [
"<string>"
],
"employeeSizeFilters": [
"<string>"
],
"revenueFilters": [
"<string>"
],
"campaignIds": [
123
],
"technologies": [
"<string>"
]
},
"subject": "<string>",
"body": "<string>",
"templateId": 123,
"scheduleAt": "2023-11-07T05:31:56Z",
"idempotencyKey": "<string>"
}
'import requests
url = "https://api.seamless.ai/api/client/v2/emails/send-bulk"
payload = {
"from": "<string>",
"filters": {
"contactIds": [123],
"lists": [123],
"queryText": "<string>",
"queryTextName": "<string>",
"queryTextCompany": "<string>",
"queryTextDomain": "<string>",
"queryTextTitle": "<string>",
"queryTextLocation": "<string>",
"industryFilters": ["<string>"],
"companyFilters": ["<string>"],
"seniorities": ["<string>"],
"departments": ["<string>"],
"prospectStatuses": ["<string>"],
"engagementStatuses": ["<string>"],
"employeeSizeFilters": ["<string>"],
"revenueFilters": ["<string>"],
"campaignIds": [123],
"technologies": ["<string>"]
},
"subject": "<string>",
"body": "<string>",
"templateId": 123,
"scheduleAt": "2023-11-07T05:31:56Z",
"idempotencyKey": "<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({
from: '<string>',
filters: {
contactIds: [123],
lists: [123],
queryText: '<string>',
queryTextName: '<string>',
queryTextCompany: '<string>',
queryTextDomain: '<string>',
queryTextTitle: '<string>',
queryTextLocation: '<string>',
industryFilters: ['<string>'],
companyFilters: ['<string>'],
seniorities: ['<string>'],
departments: ['<string>'],
prospectStatuses: ['<string>'],
engagementStatuses: ['<string>'],
employeeSizeFilters: ['<string>'],
revenueFilters: ['<string>'],
campaignIds: [123],
technologies: ['<string>']
},
subject: '<string>',
body: JSON.stringify('<string>'),
templateId: 123,
scheduleAt: '2023-11-07T05:31:56Z',
idempotencyKey: '<string>'
})
};
fetch('https://api.seamless.ai/api/client/v2/emails/send-bulk', 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.seamless.ai/api/client/v2/emails/send-bulk",
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([
'from' => '<string>',
'filters' => [
'contactIds' => [
123
],
'lists' => [
123
],
'queryText' => '<string>',
'queryTextName' => '<string>',
'queryTextCompany' => '<string>',
'queryTextDomain' => '<string>',
'queryTextTitle' => '<string>',
'queryTextLocation' => '<string>',
'industryFilters' => [
'<string>'
],
'companyFilters' => [
'<string>'
],
'seniorities' => [
'<string>'
],
'departments' => [
'<string>'
],
'prospectStatuses' => [
'<string>'
],
'engagementStatuses' => [
'<string>'
],
'employeeSizeFilters' => [
'<string>'
],
'revenueFilters' => [
'<string>'
],
'campaignIds' => [
123
],
'technologies' => [
'<string>'
]
],
'subject' => '<string>',
'body' => '<string>',
'templateId' => 123,
'scheduleAt' => '2023-11-07T05:31:56Z',
'idempotencyKey' => '<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.seamless.ai/api/client/v2/emails/send-bulk"
payload := strings.NewReader("{\n \"from\": \"<string>\",\n \"filters\": {\n \"contactIds\": [\n 123\n ],\n \"lists\": [\n 123\n ],\n \"queryText\": \"<string>\",\n \"queryTextName\": \"<string>\",\n \"queryTextCompany\": \"<string>\",\n \"queryTextDomain\": \"<string>\",\n \"queryTextTitle\": \"<string>\",\n \"queryTextLocation\": \"<string>\",\n \"industryFilters\": [\n \"<string>\"\n ],\n \"companyFilters\": [\n \"<string>\"\n ],\n \"seniorities\": [\n \"<string>\"\n ],\n \"departments\": [\n \"<string>\"\n ],\n \"prospectStatuses\": [\n \"<string>\"\n ],\n \"engagementStatuses\": [\n \"<string>\"\n ],\n \"employeeSizeFilters\": [\n \"<string>\"\n ],\n \"revenueFilters\": [\n \"<string>\"\n ],\n \"campaignIds\": [\n 123\n ],\n \"technologies\": [\n \"<string>\"\n ]\n },\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"templateId\": 123,\n \"scheduleAt\": \"2023-11-07T05:31:56Z\",\n \"idempotencyKey\": \"<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.seamless.ai/api/client/v2/emails/send-bulk")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"from\": \"<string>\",\n \"filters\": {\n \"contactIds\": [\n 123\n ],\n \"lists\": [\n 123\n ],\n \"queryText\": \"<string>\",\n \"queryTextName\": \"<string>\",\n \"queryTextCompany\": \"<string>\",\n \"queryTextDomain\": \"<string>\",\n \"queryTextTitle\": \"<string>\",\n \"queryTextLocation\": \"<string>\",\n \"industryFilters\": [\n \"<string>\"\n ],\n \"companyFilters\": [\n \"<string>\"\n ],\n \"seniorities\": [\n \"<string>\"\n ],\n \"departments\": [\n \"<string>\"\n ],\n \"prospectStatuses\": [\n \"<string>\"\n ],\n \"engagementStatuses\": [\n \"<string>\"\n ],\n \"employeeSizeFilters\": [\n \"<string>\"\n ],\n \"revenueFilters\": [\n \"<string>\"\n ],\n \"campaignIds\": [\n 123\n ],\n \"technologies\": [\n \"<string>\"\n ]\n },\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"templateId\": 123,\n \"scheduleAt\": \"2023-11-07T05:31:56Z\",\n \"idempotencyKey\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.seamless.ai/api/client/v2/emails/send-bulk")
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 \"from\": \"<string>\",\n \"filters\": {\n \"contactIds\": [\n 123\n ],\n \"lists\": [\n 123\n ],\n \"queryText\": \"<string>\",\n \"queryTextName\": \"<string>\",\n \"queryTextCompany\": \"<string>\",\n \"queryTextDomain\": \"<string>\",\n \"queryTextTitle\": \"<string>\",\n \"queryTextLocation\": \"<string>\",\n \"industryFilters\": [\n \"<string>\"\n ],\n \"companyFilters\": [\n \"<string>\"\n ],\n \"seniorities\": [\n \"<string>\"\n ],\n \"departments\": [\n \"<string>\"\n ],\n \"prospectStatuses\": [\n \"<string>\"\n ],\n \"engagementStatuses\": [\n \"<string>\"\n ],\n \"employeeSizeFilters\": [\n \"<string>\"\n ],\n \"revenueFilters\": [\n \"<string>\"\n ],\n \"campaignIds\": [\n 123\n ],\n \"technologies\": [\n \"<string>\"\n ]\n },\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"templateId\": 123,\n \"scheduleAt\": \"2023-11-07T05:31:56Z\",\n \"idempotencyKey\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"jobId": 123,
"matched": 123,
"queued": 123,
"skipped": 123
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}