Skip to main content
POST
/
v3
/
contacts
/
import
Import contacts
curl --request POST \
  --url https://api.reply.io/v3/contacts/import \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "items": [
    {
      "email": "john@example.com",
      "firstName": "John",
      "lastName": "Doe",
      "company": "Acme"
    },
    {
      "email": "jane@example.com",
      "firstName": "Jane",
      "lastName": "Smith",
      "company": "Globex"
    }
  ],
  "options": {
    "overwriteExisting": false,
    "skipExisting": true,
    "detectTimeZone": true,
    "listIds": [
      10,
      20
    ]
  }
}
'
{
  "items": [
    {
      "id": 12345,
      "status": "created",
      "error": null
    },
    {
      "id": 12346,
      "status": "updated",
      "error": null
    },
    {
      "id": null,
      "status": "failed",
      "error": "Email is required"
    }
  ],
  "added": 1,
  "updated": 1,
  "skipped": 0,
  "failed": 1
}

Authorizations

​
Authorization
string
header
required

Authenticate every request with a Bearer token. Pass your Reply API key in the Authorization header:

Authorization: Bearer <your-api-key>

Get your API key from the Reply dashboard: Settings → API Key.

Body

application/json

Import contacts by providing an array of contact objects with optional import settings

​
items
Contact Patch Request · object[]
required

Array of contact objects to import. Uses the same fields as the contact patch model.

Minimum array length: 1
​
options
object

Import settings

Response

Contacts import processed successfully

Summary of a processed contacts import request with per-item results

​
items
object[]

Per-item result for each contact in the import request (same order as input)

​
added
integer

Number of contacts created

​
updated
integer

Number of contacts updated

​
skipped
integer

Number of contacts skipped

​
failed
integer

Number of contacts that failed