Add a Contact to a List - Salesfinity API Docs

cURL

curl --request POST \
  --url https://client-api.salesfinity.co/v1/contact-lists/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "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/{id}"

payload = {
    "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({
    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/{id}', 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/{id}",
  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([
    '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/{id}"

	payload := strings.NewReader("{\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}")

	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/{id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\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}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://client-api.salesfinity.co/v1/contact-lists/{id}")

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  \"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}"

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

POST

contact-lists

{id}

cURL

curl --request POST \
  --url https://client-api.salesfinity.co/v1/contact-lists/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "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/{id}"

payload = {
    "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({
    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/{id}', 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/{id}",
  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([
    '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/{id}"

	payload := strings.NewReader("{\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}")

	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/{id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\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}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://client-api.salesfinity.co/v1/contact-lists/{id}")

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  \"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}"

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

Adds a new contact to an existing contact list. The contact is added to both the source list and the dialing queue immediately.

Path Parameters

id (required, string): Contact list ID returned from Create a List or Get All Contact Lists.

Request Body

Field	Type	Required	Max Length	Description
`first_name`	string	No	200	Contact’s first name
`last_name`	string	No	200	Contact’s last name
`email`	string	No	320	Contact’s email address
`phone_numbers`	array	No	10 items	Array of phone number objects
`company`	string	No	300	Company name
`title`	string	No	300	Job title
`linkedin`	string	No	500	LinkedIn profile URL
`website`	string	No	500	Website URL
`account`	string	No	500	Account or organization identifier
`notes`	string	No	2,000	Free-text notes about the contact
`priority`	number	No	—	Contact priority (lower is higher priority)
`timezone`	string	No	100	IANA timezone identifier (e.g. `America/New_York`)
`external_relations`	object	No	—	External system references (e.g. CRM IDs)
`custom_fields`	array	No	10 items	Array of custom field objects. See Get Custom Fields to retrieve available fields for your team.

Phone Number Object

Field	Type	Required	Description
`type`	string	Yes	Phone number type: `mobile`, `direct`, or `office`
`number`	string	Yes	Phone number in E.164 format (e.g. `+14155552671`)
`country_code`	string	No	ISO 3166-1 alpha-2 country code (e.g. `US`)
`extension`	string	No	Phone extension

Custom Field Object

Field	Type	Required	Max Length	Description
`type`	string	Yes	—	Field data type: `string`, `number`, or `boolean`
`label`	string	Yes	100	Display label for the field
`value`	any	No	—	Field value (string, number, boolean, or string array)

Example Request

{
  "first_name": "John",
  "last_name": "Doe",
  "email": "[email protected]",
  "company": "Acme Corp",
  "title": "VP of Sales",
  "phone_numbers": [
    {
      "type": "direct",
      "number": "+14155552671"
    }
  ],
  "notes": "Interested in enterprise plan. Follow up after Q2.",
  "custom_fields": [
    {
      "type": "string",
      "label": "Industry",
      "value": "SaaS"
    },
    {
      "type": "number",
      "label": "Employee Count",
      "value": 250
    },
    {
      "type": "boolean",
      "label": "Decision Maker",
      "value": true
    }
  ]
}

Response (201)

Returns the contact list ID.

Authorizations

x-api-key

string

header

required

Path Parameters

string

required

Body

application/json

account

string

Account or organization identifier

Maximum string length: 500

first_name

string

Contact first name

Maximum string length: 200

last_name

string

Contact last name

Maximum string length: 200

string

LinkedIn profile URL

Maximum string length: 500

string

Contact email address

Maximum string length: 320

website

string

Website URL

Maximum string length: 500

notes

string

Free-text notes about the contact

Maximum string length: 2000

phone_numbers

object[]

Phone numbers (max 10 per contact)

Maximum array length: 10

Show child attributes

company

string

Company name

Maximum string length: 300

title

string

Job title

Maximum string length: 300

priority

number

Contact priority (lower is higher priority)

timezone

string

IANA timezone identifier (e.g. America/New_York)

Maximum string length: 100

external_relations

object

External system references (e.g. CRM IDs)

custom_fields

object[]

Custom fields (max 10 per contact)

Maximum array length: 10

Show child attributes

Response

201 - application/json

Contact added successfully

Create a List Remove a Contact from a List

​Path Parameters

​Request Body

​Phone Number Object

​Custom Field Object

​Example Request

​Response (201)

Authorizations

Path Parameters

Body

Response

Path Parameters

Request Body

Phone Number Object

Custom Field Object

Example Request

Response (201)