Estimate campaign reach and cost
curl --request POST \
--url https://core-service.prod.brudcast.com/api/v1/user/campaigns/estimate-recipients \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"listIds": [
"<string>"
],
"segmentIds": [
"<string>"
],
"contactIds": [
"<string>"
],
"excludeListIds": [
"<string>"
],
"excludeSegmentIds": [
"<string>"
],
"excludeContactIds": [
"<string>"
],
"channels": []
}
'import requests
url = "https://core-service.prod.brudcast.com/api/v1/user/campaigns/estimate-recipients"
payload = {
"listIds": ["<string>"],
"segmentIds": ["<string>"],
"contactIds": ["<string>"],
"excludeListIds": ["<string>"],
"excludeSegmentIds": ["<string>"],
"excludeContactIds": ["<string>"],
"channels": []
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
listIds: ['<string>'],
segmentIds: ['<string>'],
contactIds: ['<string>'],
excludeListIds: ['<string>'],
excludeSegmentIds: ['<string>'],
excludeContactIds: ['<string>'],
channels: []
})
};
fetch('https://core-service.prod.brudcast.com/api/v1/user/campaigns/estimate-recipients', 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://core-service.prod.brudcast.com/api/v1/user/campaigns/estimate-recipients",
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([
'listIds' => [
'<string>'
],
'segmentIds' => [
'<string>'
],
'contactIds' => [
'<string>'
],
'excludeListIds' => [
'<string>'
],
'excludeSegmentIds' => [
'<string>'
],
'excludeContactIds' => [
'<string>'
],
'channels' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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://core-service.prod.brudcast.com/api/v1/user/campaigns/estimate-recipients"
payload := strings.NewReader("{\n \"listIds\": [\n \"<string>\"\n ],\n \"segmentIds\": [\n \"<string>\"\n ],\n \"contactIds\": [\n \"<string>\"\n ],\n \"excludeListIds\": [\n \"<string>\"\n ],\n \"excludeSegmentIds\": [\n \"<string>\"\n ],\n \"excludeContactIds\": [\n \"<string>\"\n ],\n \"channels\": []\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<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://core-service.prod.brudcast.com/api/v1/user/campaigns/estimate-recipients")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"listIds\": [\n \"<string>\"\n ],\n \"segmentIds\": [\n \"<string>\"\n ],\n \"contactIds\": [\n \"<string>\"\n ],\n \"excludeListIds\": [\n \"<string>\"\n ],\n \"excludeSegmentIds\": [\n \"<string>\"\n ],\n \"excludeContactIds\": [\n \"<string>\"\n ],\n \"channels\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-service.prod.brudcast.com/api/v1/user/campaigns/estimate-recipients")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"listIds\": [\n \"<string>\"\n ],\n \"segmentIds\": [\n \"<string>\"\n ],\n \"contactIds\": [\n \"<string>\"\n ],\n \"excludeListIds\": [\n \"<string>\"\n ],\n \"excludeSegmentIds\": [\n \"<string>\"\n ],\n \"excludeContactIds\": [\n \"<string>\"\n ],\n \"channels\": []\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"estimatedRecipients": 123,
"total": 123,
"perChannel": {},
"credits": {
"lines": [
{
"channel": "email",
"rateCredits": 123,
"estimatedRecipients": 123,
"credits": 123
}
],
"totalCredits": 123,
"balanceCredits": 123,
"sufficient": true
}
}
}{
"success": false,
"message": "Resource not found",
"code": "E_ROW_NOT_FOUND"
}{
"success": false,
"message": "Resource not found",
"code": "E_ROW_NOT_FOUND"
}{
"success": false,
"message": "The payload is invalid",
"code": "E_VALIDATION_ERROR",
"errors": [
{
"field": "emailAddress",
"rule": "email",
"message": "The emailAddress field must be a valid email address"
}
]
}{
"success": false,
"message": "Too many requests",
"code": "E_TOO_MANY_REQUESTS",
"retryAfter": 60
}Campaigns
Estimate campaign reach and cost
Counts and prices an audience selection without saving anything, so the cost of a send is known while the campaign is still being composed. Returns the reachable recipients overall and per channel, plus the credits the selection would cost and whether the wallet balance covers them. This is a POST and so requires the campaigns:write scope even though it changes nothing.
POST
/
api
/
v1
/
user
/
campaigns
/
estimate-recipients
Estimate campaign reach and cost
curl --request POST \
--url https://core-service.prod.brudcast.com/api/v1/user/campaigns/estimate-recipients \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"listIds": [
"<string>"
],
"segmentIds": [
"<string>"
],
"contactIds": [
"<string>"
],
"excludeListIds": [
"<string>"
],
"excludeSegmentIds": [
"<string>"
],
"excludeContactIds": [
"<string>"
],
"channels": []
}
'import requests
url = "https://core-service.prod.brudcast.com/api/v1/user/campaigns/estimate-recipients"
payload = {
"listIds": ["<string>"],
"segmentIds": ["<string>"],
"contactIds": ["<string>"],
"excludeListIds": ["<string>"],
"excludeSegmentIds": ["<string>"],
"excludeContactIds": ["<string>"],
"channels": []
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
listIds: ['<string>'],
segmentIds: ['<string>'],
contactIds: ['<string>'],
excludeListIds: ['<string>'],
excludeSegmentIds: ['<string>'],
excludeContactIds: ['<string>'],
channels: []
})
};
fetch('https://core-service.prod.brudcast.com/api/v1/user/campaigns/estimate-recipients', 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://core-service.prod.brudcast.com/api/v1/user/campaigns/estimate-recipients",
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([
'listIds' => [
'<string>'
],
'segmentIds' => [
'<string>'
],
'contactIds' => [
'<string>'
],
'excludeListIds' => [
'<string>'
],
'excludeSegmentIds' => [
'<string>'
],
'excludeContactIds' => [
'<string>'
],
'channels' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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://core-service.prod.brudcast.com/api/v1/user/campaigns/estimate-recipients"
payload := strings.NewReader("{\n \"listIds\": [\n \"<string>\"\n ],\n \"segmentIds\": [\n \"<string>\"\n ],\n \"contactIds\": [\n \"<string>\"\n ],\n \"excludeListIds\": [\n \"<string>\"\n ],\n \"excludeSegmentIds\": [\n \"<string>\"\n ],\n \"excludeContactIds\": [\n \"<string>\"\n ],\n \"channels\": []\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<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://core-service.prod.brudcast.com/api/v1/user/campaigns/estimate-recipients")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"listIds\": [\n \"<string>\"\n ],\n \"segmentIds\": [\n \"<string>\"\n ],\n \"contactIds\": [\n \"<string>\"\n ],\n \"excludeListIds\": [\n \"<string>\"\n ],\n \"excludeSegmentIds\": [\n \"<string>\"\n ],\n \"excludeContactIds\": [\n \"<string>\"\n ],\n \"channels\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-service.prod.brudcast.com/api/v1/user/campaigns/estimate-recipients")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"listIds\": [\n \"<string>\"\n ],\n \"segmentIds\": [\n \"<string>\"\n ],\n \"contactIds\": [\n \"<string>\"\n ],\n \"excludeListIds\": [\n \"<string>\"\n ],\n \"excludeSegmentIds\": [\n \"<string>\"\n ],\n \"excludeContactIds\": [\n \"<string>\"\n ],\n \"channels\": []\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"estimatedRecipients": 123,
"total": 123,
"perChannel": {},
"credits": {
"lines": [
{
"channel": "email",
"rateCredits": 123,
"estimatedRecipients": 123,
"credits": 123
}
],
"totalCredits": 123,
"balanceCredits": 123,
"sufficient": true
}
}
}{
"success": false,
"message": "Resource not found",
"code": "E_ROW_NOT_FOUND"
}{
"success": false,
"message": "Resource not found",
"code": "E_ROW_NOT_FOUND"
}{
"success": false,
"message": "The payload is invalid",
"code": "E_VALIDATION_ERROR",
"errors": [
{
"field": "emailAddress",
"rule": "email",
"message": "The emailAddress field must be a valid email address"
}
]
}{
"success": false,
"message": "Too many requests",
"code": "E_TOO_MANY_REQUESTS",
"retryAfter": 60
}Authorizations
apiKeyapiKeyBearer
An organization API key, prefixed bk_live_. Takes precedence over Authorization when both are sent. The key is bound to one organization, and the scopes it was issued with are enforced per endpoint.
Headers
Required when authenticating with an access token. Optional with an API key, whose own organization binding is authoritative; a value contradicting it is refused with 403.
Body
application/json