Import contacts from CSV

curl --request POST \
  --url https://api.coldsend.pro/api/public/v1/contacts/import \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-API-Key: <api-key>' \
  --form file=@example-file \
  --form 'mapping=<string>' \
  --form list_id=3c90c3cc-0d44-4b50-8888-8dd25736052a \
  --form 'filename=<string>'

import requests

url = "https://api.coldsend.pro/api/public/v1/contacts/import"

files = { "file": ("example-file", open("example-file", "rb")) }
payload = {
    "mapping": "<string>",
    "list_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "filename": "<string>"
}
headers = {"X-API-Key": "<api-key>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('file', '<string>');
form.append('mapping', '<string>');
form.append('list_id', '3c90c3cc-0d44-4b50-8888-8dd25736052a');
form.append('filename', '<string>');

const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};

options.body = form;

fetch('https://api.coldsend.pro/api/public/v1/contacts/import', 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.coldsend.pro/api/public/v1/contacts/import",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mapping\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"list_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"filename\"\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Content-Type: multipart/form-data",
    "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://api.coldsend.pro/api/public/v1/contacts/import"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mapping\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"list_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"filename\"\r\n\r\n<string>\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")

	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.coldsend.pro/api/public/v1/contacts/import")
  .header("X-API-Key", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mapping\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"list_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"filename\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.coldsend.pro/api/public/v1/contacts/import")

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.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mapping\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"list_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"filename\"\r\n\r\n<string>\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "total_rows": 123,
  "imported_rows": 123,
  "skipped_rows": 123,
  "contacts_created": 123,
  "contacts_matched": 123,
  "added_to_list": 0,
  "list_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "blocked_count": 0,
  "blocked_entries": [
    {}
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Contacts

Import contacts from CSV

Import contacts into the directory from a CSV file

Upserts contacts team-wide (decision 10): an email already present updates the existing contact rather than creating a duplicate, and no campaign membership is created. Pair with POST /contacts/bulk/campaigns to enrol imported contacts into a campaign.

The mapping form field is JSON with the same direction the campaign upload uses — lead field name to CSV column header: {"email": "email_address", "first_name": "fname", "custom_city": "City"}. Keys prefixed custom_ land in the contact’s free-form custom_fields.

Example Usage

import requests

response = requests.post(
    "https://api.coldsend.pro/api/public/v1/contacts/import",
    headers={"X-API-Key": "your-api-key"},
    files={"file": open("contacts.csv", "rb")},
    data={"mapping": '{"email": "email_address", "first_name": "fname"}'}
)

print(response.json())

POST

api

public

contacts

import

Import contacts from CSV

curl --request POST \
  --url https://api.coldsend.pro/api/public/v1/contacts/import \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-API-Key: <api-key>' \
  --form file=@example-file \
  --form 'mapping=<string>' \
  --form list_id=3c90c3cc-0d44-4b50-8888-8dd25736052a \
  --form 'filename=<string>'

import requests

url = "https://api.coldsend.pro/api/public/v1/contacts/import"

files = { "file": ("example-file", open("example-file", "rb")) }
payload = {
    "mapping": "<string>",
    "list_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "filename": "<string>"
}
headers = {"X-API-Key": "<api-key>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('file', '<string>');
form.append('mapping', '<string>');
form.append('list_id', '3c90c3cc-0d44-4b50-8888-8dd25736052a');
form.append('filename', '<string>');

const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};

options.body = form;

fetch('https://api.coldsend.pro/api/public/v1/contacts/import', 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.coldsend.pro/api/public/v1/contacts/import",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mapping\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"list_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"filename\"\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Content-Type: multipart/form-data",
    "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://api.coldsend.pro/api/public/v1/contacts/import"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mapping\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"list_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"filename\"\r\n\r\n<string>\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")

	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.coldsend.pro/api/public/v1/contacts/import")
  .header("X-API-Key", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mapping\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"list_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"filename\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.coldsend.pro/api/public/v1/contacts/import")

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.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mapping\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"list_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"filename\"\r\n\r\n<string>\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "total_rows": 123,
  "imported_rows": 123,
  "skipped_rows": 123,
  "contacts_created": 123,
  "contacts_matched": 123,
  "added_to_list": 0,
  "list_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "blocked_count": 0,
  "blocked_entries": [
    {}
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

X-API-Key

string

header

required

API key with format cs_live_xxx

Body

multipart/form-data

file

required

CSV file containing contacts

mapping

string

required

JSON object mapping lead field names to CSV column headers, e.g. {"email": "email_address", "custom_city": "City"}

list_id

string<uuid> | null

Add imported contacts to this static list

filename

string | null

Origin name to record as source_name

Response

Import completed

Outcome of a directory-level CSV import.

contacts_created and contacts_matched split the imported rows into new people and people the team already had, which is the distinction decision 10 turns on: a team-wide upsert means re-importing the same file enriches the directory instead of duplicating it.

Blocked addresses are reported, not withheld. Nothing created here can send; the blocklist is enforced at the point a campaign membership is created. Surfacing the count lets the UI warn that part of a freshly imported list will not be mailable.

batch_id

string<uuid>

required

total_rows

integer

required

Data rows found in the file

imported_rows

integer

required

Rows with a usable address

skipped_rows

integer

required

Rows dropped as unusable (missing or invalid email)

contacts_created

integer

required

contacts_matched

integer

required

Rows that updated a contact the team already had

added_to_list

integer

default:0

list_id

string<uuid> | null

blocked_count

integer

default:0

blocked_entries

Blocked Entries · object[]

Campaigns

Sender Accounts

Domains

Leads

Flow

Contacts

Analytics

Replies

Webhooks

Import contacts from CSV

Example Usage

Authorizations

Body

Response