Add a contact to a list
Appends one contact to a saved list. The dialing queue does not change until you refill it with POST /v1/contact-lists/csv/{id}/reimport, so add every contact first and refill once.
The response is { "success": true }; it does not include the new contact’s _id. Read contact IDs with GET /v1/contact-lists/csv/{id}.
Nothing checks for duplicates or for the list’s size: each call appends a contact, even an identical one, and a list can grow past the 2,000 contacts POST /v1/contact-lists accepts at once. A retry after a timeout can therefore add the contact twice; search the list before retrying.
Bodies can be up to 10 MB. A field the contact object does not define is rejected with 400.
contacts in Create a contact list: 10 phone numbers, 10 custom fields and 2,000 characters of notes at most.
Example
{ "success": true }, although the response schema on this page shows an ID. To find the new contact’s _id, read the list with Get a contact list and search for the contact.
Behavior
- No duplicate check: each call appends a contact, even one identical to a contact already in the list. A retry after a timeout can add the contact twice, so search the list before retrying.
- No size check: the list can grow past the 2,000 contacts that Create a contact list accepts in one request.
- An unknown field fails the request with 400. Phone numbers are stored exactly as sent, so send them in E.164 format.
- Custom field labels are free text. To match the fields a CRM import creates, reuse an
internal_namefrom List custom field mappings.
Errors
Authorizations
Team-scoped API key generated in the Salesfinity dashboard under Settings → Connections → API & Webhooks. A missing or invalid key returns HTTP 403.
Path Parameters
ID of the saved list, from POST /v1/contact-lists or GET /v1/contact-lists/csv. A value that is not a valid ID fails with 400.
"6650c1f2a4b8e93d2c1f0a11"
Body
Account or organization identifier, such as an account name or ID from your CRM.
500"acme-corp"
First name.
200"Jane"
Last name.
200"Doe"
LinkedIn profile URL.
500"https://www.linkedin.com/in/jane-doe-4b21a3"
Website URL.
500"https://acme.com"
Free-text notes about the contact, at most 2,000 characters.
2000"Interested in the enterprise plan. Call back after Q2."
Phone numbers, at most 10.
10Company name.
300"Acme Corp"
Job title.
300"VP of Sales"
A number reps can sort and group the dialer queue by.
1
IANA time zone name, such as America/New_York. Not validated.
100"America/New_York"
Free-form object stored and returned with the contact, for references to other systems.
Custom fields, at most 10.
10Response
Added. Production returns { "success": true }, not the ID shown in this schema; see the operation description.
A 24-character hexadecimal identifier for a Salesfinity resource. Returned on its own by endpoints whose only result is the id of the record they created or affected.
^[0-9a-fA-F]{24}$"507f1f77bcf86cd799439011"