Skip to main content
POST
/
contacts
/
import
Import contacts
curl --request POST \
  --url https://api.reply.io/v3/contacts/import \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "headers": [
    "Email",
    "FirstName",
    "LastName",
    "CompanyName"
  ],
  "rows": [
    [
      "john@example.com",
      "John",
      "Doe",
      "Acme"
    ],
    [
      "jane@example.com",
      "Jane",
      "Smith",
      "Globex"
    ]
  ]
}
'
{
  "importedCount": 2,
  "failedCount": 1,
  "errors": [
    {
      "rowIndex": 1,
      "message": "Email is required"
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required

API key passed in the X-API-Key header

Body

application/json

Tabular JSON payload used to import contacts

​
headers
string[]
required

Column names used to map values in each row

Minimum array length: 1
​
rows
string[][]
required

Tabular data rows. Each row must align with the headers array order and length.

Minimum array length: 1

Response

Contacts import processed successfully

Summary of a processed contacts import request

​
importedCount
integer
required

Number of rows successfully imported

Required range: x >= 0
​
failedCount
integer
required

Number of rows that failed validation or import

Required range: x >= 0
​
errors
object[]
required

Row-level import errors. rowIndex is zero-based.