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 '
{
  "first_name": "<string>",
  "phone_numbers": [
    {
      "type": "mobile",
      "number": "<string>",
      "country_code": "<string>",
      "extension": "<string>"
    }
  ],
  "account": "<string>",
  "last_name": "<string>",
  "linkedin": "<string>",
  "email": "<string>",
  "website": "<string>",
  "notes": "<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, identified by the list ID. Important: Once you add contacts to a list, they won’t automatically appear on the dialer. To make sure contacts appear on the dialer, you need to call the reimport endpoint. See: Reimport Contacts

​
Path Parameters

  • id (required, string): Contact list ID

​
Request Body

FieldTypeRequiredDescription
first_namestringNoContact’s first name
last_namestringNoContact’s last name
emailstringNoContact’s email address
phone_numbersarrayNoArray of phone number objects
companystringNoCompany name
titlestringNoJob title
linkedinstringNoLinkedIn profile URL
websitestringNoWebsite URL
accountstringNoAccount name
notesstringNoAdditional notes
prioritynumberNoContact priority
timezonestringNoContact’s timezone
external_relationsobjectNoExternal CRM relations
custom_fieldsarrayNoArray 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
country_codestringNoCountry code
extensionstringNoPhone extension

​
Custom Field Object

FieldTypeRequiredDescription
typestringYesField data type: string, number, or boolean
labelstringYesDisplay label for the field
valueanyNoField 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": "+1234567890"
    }
  ],
  "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 newly added contact details.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string
required

Body

application/json
​
first_name
string
required
​
phone_numbers
object[]
required
​
account
string
​
last_name
string
​
linkedin
string
​
email
string
​
website
string
​
notes
string
​
company
string
​
title
string
​
priority
number
​
timezone
string
​
external_relations
object
​
custom_fields
object[]

Custom field values for the contact

Response

201 - application/json

Contact added successfully