Import contact collection


This method allows you submit data in bulk and an asynchronous calling pattern:





The method for polling for import job status is Get import status and once complete also returns the import report showing what contacts were created, updated or failed; this is also when you can capture the contactId for each contact sent to Dotdigital.


📘

Phone numbers

Phone numbers must be in international format (E.164); Google have a good library for reformatting phone number called libphonenumber which has been ported to most languages.

📘

Import limits

Your JSON request body can be a maximum size of 50MB, therefore allowing a large number of contacts to be imported in a single call.

Active contact imports are limited to 25. If you exceed this limit, you get the Too many active imports error.

🚧

Specifying null for a data fields value clears the field

You must ensure that you only pass the fields you require to be updated for a contact.

We interpret a field passed with a null value as an instruction to clear the value for that field.

Note: This only works with data fields in this call,not identifiers.


Body Params

Contact data collection

string
enum
Defaults to overwrite
Allowed:
contacts
array of objects
required
length ≥ 1
contacts*

string
required
identifiers
object
required
dataFields
object
channelProperties
object
lists
array of int32s
length between 1 and 100
lists

preferences
array of objects
length ≥ 1
preferences
int32
required
boolean
required
consentRecords
array of objects
length between 1 and 5
consentRecords

string
required
length ≥ 1
date-time
required
uri
required
required
string
required
length ≥ 1
Headers
string
Responses

401

Unauthorized

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json