Skip to main content
POST
/
v1
/
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": [
    {
      "type": "mobile",
      "number": "<string>",
      "country_code": "<string>",
      "extension": "<string>"
    }
  ],
  "company": "<string>",
  "title": "<string>",
  "priority": 123,
  "timezone": "<string>",
  "external_relations": {},
  "custom_fields": [
    {
      "type": "string",
      "label": "<string>",
      "value": "<unknown>"
    }
  ]
}
'
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

​
Request Body

FieldTypeRequiredMax LengthDescription
first_namestringNo200Contact’s first name
last_namestringNo200Contact’s last name
emailstringNo320Contact’s email address
phone_numbersarrayNo10 itemsArray of phone number objects
companystringNo300Company name
titlestringNo300Job title
linkedinstringNo500LinkedIn profile URL
websitestringNo500Website URL
accountstringNo500Account or organization identifier
notesstringNo2,000Free-text notes about the contact
prioritynumberNo—Contact priority (lower is higher priority)
timezonestringNo100IANA timezone identifier (e.g. America/New_York)
external_relationsobjectNo—External system references (e.g. CRM IDs)
custom_fieldsarrayNo10 itemsArray of custom field objects. See Get Custom Fields to retrieve available fields for your team.

​
Phone Number Object

FieldTypeRequiredDescription
typestringYesPhone number type: mobile, direct, or office
numberstringYesPhone number in E.164 format (e.g. +14155552671)
country_codestringNoISO 3166-1 alpha-2 country code (e.g. US)
extensionstringNoPhone extension

​
Custom Field Object

FieldTypeRequiredMax LengthDescription
typestringYes—Field data type: string, number, or boolean
labelstringYes100Display label for the field
valueanyNo—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

​
id
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
​
linkedin
string

LinkedIn profile URL

Maximum string length: 500
​
email
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
​
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

Response

201 - application/json

Contact added successfully