cURL
curl --request POST \
--url https://client-api.salesfinity.co/v1/contact-lists \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"user_id": "<string>",
"contacts": [
{
"account": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"linkedin": "<string>",
"email": "<string>",
"website": "<string>",
"notes": "<string>",
"phone_numbers": [
{
"number": "<string>",
"country_code": "<string>",
"extension": "<string>"
}
],
"company": "<string>",
"title": "<string>",
"priority": 123,
"timezone": "<string>",
"external_relations": {},
"custom_fields": [
{
"label": "<string>",
"value": "<unknown>"
}
]
}
]
}
'import requests
url = "https://client-api.salesfinity.co/v1/contact-lists"
payload = {
"name": "<string>",
"user_id": "<string>",
"contacts": [
{
"account": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"linkedin": "<string>",
"email": "<string>",
"website": "<string>",
"notes": "<string>",
"phone_numbers": [
{
"number": "<string>",
"country_code": "<string>",
"extension": "<string>"
}
],
"company": "<string>",
"title": "<string>",
"priority": 123,
"timezone": "<string>",
"external_relations": {},
"custom_fields": [
{
"label": "<string>",
"value": "<unknown>"
}
]
}
]
}
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({
name: '<string>',
user_id: '<string>',
contacts: [
{
account: '<string>',
first_name: '<string>',
last_name: '<string>',
linkedin: '<string>',
email: '<string>',
website: '<string>',
notes: '<string>',
phone_numbers: [{number: '<string>', country_code: '<string>', extension: '<string>'}],
company: '<string>',
title: '<string>',
priority: 123,
timezone: '<string>',
external_relations: {},
custom_fields: [{label: '<string>', value: '<unknown>'}]
}
]
})
};
fetch('https://client-api.salesfinity.co/v1/contact-lists', 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://client-api.salesfinity.co/v1/contact-lists",
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([
'name' => '<string>',
'user_id' => '<string>',
'contacts' => [
[
'account' => '<string>',
'first_name' => '<string>',
'last_name' => '<string>',
'linkedin' => '<string>',
'email' => '<string>',
'website' => '<string>',
'notes' => '<string>',
'phone_numbers' => [
[
'number' => '<string>',
'country_code' => '<string>',
'extension' => '<string>'
]
],
'company' => '<string>',
'title' => '<string>',
'priority' => 123,
'timezone' => '<string>',
'external_relations' => [
],
'custom_fields' => [
[
'label' => '<string>',
'value' => '<unknown>'
]
]
]
]
]),
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://client-api.salesfinity.co/v1/contact-lists"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"user_id\": \"<string>\",\n \"contacts\": [\n {\n \"account\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"linkedin\": \"<string>\",\n \"email\": \"<string>\",\n \"website\": \"<string>\",\n \"notes\": \"<string>\",\n \"phone_numbers\": [\n {\n \"number\": \"<string>\",\n \"country_code\": \"<string>\",\n \"extension\": \"<string>\"\n }\n ],\n \"company\": \"<string>\",\n \"title\": \"<string>\",\n \"priority\": 123,\n \"timezone\": \"<string>\",\n \"external_relations\": {},\n \"custom_fields\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ]\n }\n ]\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://client-api.salesfinity.co/v1/contact-lists")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"user_id\": \"<string>\",\n \"contacts\": [\n {\n \"account\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"linkedin\": \"<string>\",\n \"email\": \"<string>\",\n \"website\": \"<string>\",\n \"notes\": \"<string>\",\n \"phone_numbers\": [\n {\n \"number\": \"<string>\",\n \"country_code\": \"<string>\",\n \"extension\": \"<string>\"\n }\n ],\n \"company\": \"<string>\",\n \"title\": \"<string>\",\n \"priority\": 123,\n \"timezone\": \"<string>\",\n \"external_relations\": {},\n \"custom_fields\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://client-api.salesfinity.co/v1/contact-lists")
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 \"name\": \"<string>\",\n \"user_id\": \"<string>\",\n \"contacts\": [\n {\n \"account\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"linkedin\": \"<string>\",\n \"email\": \"<string>\",\n \"website\": \"<string>\",\n \"notes\": \"<string>\",\n \"phone_numbers\": [\n {\n \"number\": \"<string>\",\n \"country_code\": \"<string>\",\n \"extension\": \"<string>\"\n }\n ],\n \"company\": \"<string>\",\n \"title\": \"<string>\",\n \"priority\": 123,\n \"timezone\": \"<string>\",\n \"external_relations\": {},\n \"custom_fields\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{}{
"error": 123,
"message": "<string>"
}Contact Lists
Create a List
Creates a new contact list
POST
/
v1
/
contact-lists
cURL
curl --request POST \
--url https://client-api.salesfinity.co/v1/contact-lists \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"user_id": "<string>",
"contacts": [
{
"account": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"linkedin": "<string>",
"email": "<string>",
"website": "<string>",
"notes": "<string>",
"phone_numbers": [
{
"number": "<string>",
"country_code": "<string>",
"extension": "<string>"
}
],
"company": "<string>",
"title": "<string>",
"priority": 123,
"timezone": "<string>",
"external_relations": {},
"custom_fields": [
{
"label": "<string>",
"value": "<unknown>"
}
]
}
]
}
'import requests
url = "https://client-api.salesfinity.co/v1/contact-lists"
payload = {
"name": "<string>",
"user_id": "<string>",
"contacts": [
{
"account": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"linkedin": "<string>",
"email": "<string>",
"website": "<string>",
"notes": "<string>",
"phone_numbers": [
{
"number": "<string>",
"country_code": "<string>",
"extension": "<string>"
}
],
"company": "<string>",
"title": "<string>",
"priority": 123,
"timezone": "<string>",
"external_relations": {},
"custom_fields": [
{
"label": "<string>",
"value": "<unknown>"
}
]
}
]
}
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({
name: '<string>',
user_id: '<string>',
contacts: [
{
account: '<string>',
first_name: '<string>',
last_name: '<string>',
linkedin: '<string>',
email: '<string>',
website: '<string>',
notes: '<string>',
phone_numbers: [{number: '<string>', country_code: '<string>', extension: '<string>'}],
company: '<string>',
title: '<string>',
priority: 123,
timezone: '<string>',
external_relations: {},
custom_fields: [{label: '<string>', value: '<unknown>'}]
}
]
})
};
fetch('https://client-api.salesfinity.co/v1/contact-lists', 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://client-api.salesfinity.co/v1/contact-lists",
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([
'name' => '<string>',
'user_id' => '<string>',
'contacts' => [
[
'account' => '<string>',
'first_name' => '<string>',
'last_name' => '<string>',
'linkedin' => '<string>',
'email' => '<string>',
'website' => '<string>',
'notes' => '<string>',
'phone_numbers' => [
[
'number' => '<string>',
'country_code' => '<string>',
'extension' => '<string>'
]
],
'company' => '<string>',
'title' => '<string>',
'priority' => 123,
'timezone' => '<string>',
'external_relations' => [
],
'custom_fields' => [
[
'label' => '<string>',
'value' => '<unknown>'
]
]
]
]
]),
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://client-api.salesfinity.co/v1/contact-lists"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"user_id\": \"<string>\",\n \"contacts\": [\n {\n \"account\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"linkedin\": \"<string>\",\n \"email\": \"<string>\",\n \"website\": \"<string>\",\n \"notes\": \"<string>\",\n \"phone_numbers\": [\n {\n \"number\": \"<string>\",\n \"country_code\": \"<string>\",\n \"extension\": \"<string>\"\n }\n ],\n \"company\": \"<string>\",\n \"title\": \"<string>\",\n \"priority\": 123,\n \"timezone\": \"<string>\",\n \"external_relations\": {},\n \"custom_fields\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ]\n }\n ]\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://client-api.salesfinity.co/v1/contact-lists")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"user_id\": \"<string>\",\n \"contacts\": [\n {\n \"account\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"linkedin\": \"<string>\",\n \"email\": \"<string>\",\n \"website\": \"<string>\",\n \"notes\": \"<string>\",\n \"phone_numbers\": [\n {\n \"number\": \"<string>\",\n \"country_code\": \"<string>\",\n \"extension\": \"<string>\"\n }\n ],\n \"company\": \"<string>\",\n \"title\": \"<string>\",\n \"priority\": 123,\n \"timezone\": \"<string>\",\n \"external_relations\": {},\n \"custom_fields\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://client-api.salesfinity.co/v1/contact-lists")
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 \"name\": \"<string>\",\n \"user_id\": \"<string>\",\n \"contacts\": [\n {\n \"account\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"linkedin\": \"<string>\",\n \"email\": \"<string>\",\n \"website\": \"<string>\",\n \"notes\": \"<string>\",\n \"phone_numbers\": [\n {\n \"number\": \"<string>\",\n \"country_code\": \"<string>\",\n \"extension\": \"<string>\"\n }\n ],\n \"company\": \"<string>\",\n \"title\": \"<string>\",\n \"priority\": 123,\n \"timezone\": \"<string>\",\n \"external_relations\": {},\n \"custom_fields\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{}{
"error": 123,
"message": "<string>"
}Creates a new contact list for the team. Contacts are optional and can be added later via the Add Contact endpoint.
Limits
| Resource | Limit |
|---|---|
| Contacts per list | 2,000 |
| List name | 1–100 characters |
| Notes per contact | 2,000 characters |
| Phone numbers per contact | 10 |
| Custom fields per contact | 10 |
| Request payload size | 10MB |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Name of the contact list (1–100 characters) |
user_id | string | Yes | ID of the team member who owns this list. Must be a valid member of the team. Get this from Get Team. |
contacts | array | No | Array of contact objects (max 2,000). See Add Contact for the contact object schema. |
Example Request
{
"name": "Q2 Outbound Prospects",
"user_id": "680edc0d1504192884a148e0",
"contacts": [
{
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"company": "Acme Corp",
"title": "VP of Sales",
"phone_numbers": [
{
"type": "direct",
"number": "+14155552671"
}
]
}
]
}
Example Request (empty list)
{
"name": "Q2 Outbound Prospects",
"user_id": "680edc0d1504192884a148e0"
}
Response (201)
Returns the created contact list object with its_id. Use this ID for all subsequent operations (adding contacts, merging, deleting, etc.).Authorizations
Body
application/json
Response
Contact list created successfully
The response is of type object.
⌘I