Preview a contact import
curl --request POST \
--url https://core-service.prod.brudcast.com/api/v1/user/contact-imports/{id}/preview \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"fieldMappings": [
{
"csvHeader": "<string>",
"brudcastField": "<string>"
}
],
"allowPartialUpload": true
}
'import requests
url = "https://core-service.prod.brudcast.com/api/v1/user/contact-imports/{id}/preview"
payload = {
"fieldMappings": [
{
"csvHeader": "<string>",
"brudcastField": "<string>"
}
],
"allowPartialUpload": True
}
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({
fieldMappings: [{csvHeader: '<string>', brudcastField: '<string>'}],
allowPartialUpload: true
})
};
fetch('https://core-service.prod.brudcast.com/api/v1/user/contact-imports/{id}/preview', 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/contact-imports/{id}/preview",
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([
'fieldMappings' => [
[
'csvHeader' => '<string>',
'brudcastField' => '<string>'
]
],
'allowPartialUpload' => true
]),
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/contact-imports/{id}/preview"
payload := strings.NewReader("{\n \"fieldMappings\": [\n {\n \"csvHeader\": \"<string>\",\n \"brudcastField\": \"<string>\"\n }\n ],\n \"allowPartialUpload\": true\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/contact-imports/{id}/preview")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"fieldMappings\": [\n {\n \"csvHeader\": \"<string>\",\n \"brudcastField\": \"<string>\"\n }\n ],\n \"allowPartialUpload\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-service.prod.brudcast.com/api/v1/user/contact-imports/{id}/preview")
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 \"fieldMappings\": [\n {\n \"csvHeader\": \"<string>\",\n \"brudcastField\": \"<string>\"\n }\n ],\n \"allowPartialUpload\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"preview": {
"totalRows": 123,
"newCount": 123,
"duplicateCount": 123,
"errorCount": 123,
"sampleErrors": [
{
"row": 123,
"reason": "<string>"
}
]
}
}
}{
"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": "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
}Contacts
Preview a contact import
Dry-runs the uploaded file against the proposed mappings and answers with the counts the confirmation step needs. No contacts are written and nothing about the proposal is persisted, so the same draft can be previewed repeatedly with different mappings. sampleErrors is capped at the first ten failing rows. Requires the contacts:write scope.
POST
/
api
/
v1
/
user
/
contact-imports
/
{id}
/
preview
Preview a contact import
curl --request POST \
--url https://core-service.prod.brudcast.com/api/v1/user/contact-imports/{id}/preview \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"fieldMappings": [
{
"csvHeader": "<string>",
"brudcastField": "<string>"
}
],
"allowPartialUpload": true
}
'import requests
url = "https://core-service.prod.brudcast.com/api/v1/user/contact-imports/{id}/preview"
payload = {
"fieldMappings": [
{
"csvHeader": "<string>",
"brudcastField": "<string>"
}
],
"allowPartialUpload": True
}
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({
fieldMappings: [{csvHeader: '<string>', brudcastField: '<string>'}],
allowPartialUpload: true
})
};
fetch('https://core-service.prod.brudcast.com/api/v1/user/contact-imports/{id}/preview', 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/contact-imports/{id}/preview",
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([
'fieldMappings' => [
[
'csvHeader' => '<string>',
'brudcastField' => '<string>'
]
],
'allowPartialUpload' => true
]),
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/contact-imports/{id}/preview"
payload := strings.NewReader("{\n \"fieldMappings\": [\n {\n \"csvHeader\": \"<string>\",\n \"brudcastField\": \"<string>\"\n }\n ],\n \"allowPartialUpload\": true\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/contact-imports/{id}/preview")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"fieldMappings\": [\n {\n \"csvHeader\": \"<string>\",\n \"brudcastField\": \"<string>\"\n }\n ],\n \"allowPartialUpload\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-service.prod.brudcast.com/api/v1/user/contact-imports/{id}/preview")
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 \"fieldMappings\": [\n {\n \"csvHeader\": \"<string>\",\n \"brudcastField\": \"<string>\"\n }\n ],\n \"allowPartialUpload\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"preview": {
"totalRows": 123,
"newCount": 123,
"duplicateCount": 123,
"errorCount": 123,
"sampleErrors": [
{
"row": 123,
"reason": "<string>"
}
]
}
}
}{
"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": "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.
Path Parameters
Body
application/json