API Docs

Import Contacts

Import contacts to a contact list. Supports direct JSON or file URL imports.

POST/api/v1/contact-lists/{id}/contacts
Async processing
All imports are processed asynchronously. The response includes a job ID that you can use to track progress via the Import Jobs API.

Authorization

ParameterTypeDescription
x-api-keyrequired
string

Your API key

Example: dk_...

Path Parameters

ParameterTypeDescription
idrequired
string

The contact list ID

Example: cl_abc123

Request Body

Content-Type: application/json

ParameterTypeDescription
contacts
object[]

Array of contact objects to import (for direct JSON import)

fileUrl
string

URL to a JSON or CSV file containing contacts (for file URL import)

fileFormat
"json" | "csv"

Format of the file (required when using fileUrl)

Responses

{
  "jobId": "job_xyz789",
  "status": "pending",
  "message": "Import job created. Use GET /api/v1/import-jobs/{jobId} to track progress."
}
POST /api/v1/contact-lists/{id}/contacts
curl -X POST "https://voice.evryhealth.com/api/v1/contact-lists/{id}/contacts" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "contacts": [
      {
        "firstName": "John",
        "lastName": "Doe",
        "phoneNumber": "+14155551234",
        "company": "Acme Corp"
      },
      {
        "firstName": "Jane",
        "lastName": "Smith",
        "phoneNumber": "+14155555678",
        "company": "Tech Inc"
      }
    ]
  }'
Response202
{
  "jobId": "job_xyz789",
  "status": "pending",
  "message": "Import job created. Use GET /api/v1/import-jobs/{jobId} to track progress."
}

Import Options

Direct JSON Import

Send contacts directly in the request body as a JSON array:

{
  "contacts": [
    {
      "firstName": "John",
      "lastName": "Doe",
      "phoneNumber": "+14155551234",
      "company": "Acme Corp",
      "leadScore": 85
    },
    {
      "firstName": "Jane",
      "lastName": "Smith",
      "phoneNumber": "+14155555678",
      "company": "Tech Inc",
      "leadScore": 92
    }
  ]
}

File URL Import

For large datasets, provide a URL to a file containing your contacts:

{
  "fileUrl": "https://example.com/contacts.json",
  "fileFormat": "json"
}
Supported formats
  • JSON - Array of contact objects
  • CSV - Header row with field names, data rows

CSV Format Example

firstName,lastName,phoneNumber,company,leadScore
John,Doe,+14155551234,Acme Corp,85
Jane,Smith,+14155555678,Tech Inc,92

List Contacts

GET/api/v1/contact-lists/{id}/contacts

Get a paginated list of contacts in a contact list.

Query Parameters

ParameterTypeDescription
pagenumberPage number (default: 1)
limitnumberItems per page (default: 50, max: 100)
searchstringSearch contacts by name or phone