POST contacts/import

Save multiple contact records from a JSON array. All records in array must match in structure! The structure is defined by the first record. All records must contain an email address. Max of 1000 records at a time. Suppressed contact records cannot be unsuppressed through this endpoint.

* required

Parameters

Name	Type	Description
contacts *	array	Array of JSON objects (up to 1000) containing contact data. Each object should contain key/value pairs for every field being imported. If custom field data is included, it should be in a nested object named "customFields". e.g. "customFields":{"custom1":{"value":"Example value"},{"custom2":{"value":"Example value"}}} Max: 1000
groupIDs	array[integer]	Add all imported contacts to these groups. Contacts cannot be added to dynamic groups.
removeGroupIDs	array[integer]	Remove all imported contacts from these groups
updateExisting	boolean	Update existing records with data provided. If set to "0", existing records will be not be updated, but will still be added/removed from groups. Existing records are matched on email address. Default: 1

Response Data

Name	Type	Description
recordsUpdated	integer	Number of existing records updated by import
recordsInserted	integer	Number of new records created by import
recordsInData	integer	Total records passed in
contactResults	array	Array of objects containing results for each row from the contacts argument (the order will be the same). Changes to group membership are not included. Each row will contain: email, contactID (only populated if success equals true), success, inserted, updated, and errors. e.g "contacts":[{"email": "john.doe1@example.com", "contactID": 123, "success": 1, "inserted": 1, "updated": 0, "errors": []}]

Permissions

Method requires the Contacts (Import) permission

Example Calls

Basic Import

POST

/contacts/import

cURL

Copy

curl https://api.emailer.emfluence.com/v1/contacts/import \
	-H "Authorization: Bearer {{accessToken}}" \
	-H "Content-Type: application/json" \
	-X POST \
	-d '{
		"contacts": [
			{"email":"john.doe1@example.com","firstName":"John","lastName":"Doe"},
			{"email":"john.doe2@example.com","firstName":"John","lastName":"Doe II"},
			{"email":"jane.doe@example.com","firstName":"Jane","lastName":"Doe"}
		]
	}'

Response Data

{"extrainfo":"Duplicate emails are removed from the imported data (first occurrence is used).","success":1,"data":{"recordsInserted":2,"recordsInData":3,"recordsUpdated":1,"contactResults":[{"email":"john.doe1@example.com","contactID":1929391,"success":1,"inserted":1,"updated":0,"errors":[]},{"email":"john.doe2@example.com","contactID":1929392,"success":1,"inserted":1,"updated":0,"errors":[]},{"email":"jane.doe@example.com","contactID":1929393,"success":1,"inserted":0,"updated":1,"errors":[]}]},"code":0,"requestID":"8752CAA6-59A1-4AF5-91E833BEB794327B"}

Import With Failed Rows

Individual rows can fail independently from the API call itself. If a row has an error, it will still be included in the "contactResults", success will be 0, and the errors array will contain details about the error. In addition, the top-level "warnings" key will include details about the error.

POST

/contacts/import

cURL

Copy

curl https://api.emailer.emfluence.com/v1/contacts/import \
	-H "Authorization: Bearer {{accessToken}}" \
	-H "Content-Type: application/json" \
	-X POST \
	-d '{
		"contacts": [
			{"email":"john.doe1@example.com","firstName":"John","lastName":"Doe"},
			{"email":"john.doe2","firstName":"John","lastName":"Doe II"},
			{"email":"jane.doe@example.com","firstName":"Jane","lastName":"Doe"}
		]
	}'

Response Data

{"extrainfo":"Duplicate emails are removed from the imported data (first occurrence is used).","warnings":["Row 2, email: Invalid email address [john.doe2]"],"success":1,"data":{"recordsInserted":1,"recordsInData":3,"recordsUpdated":1,"contactResults":[{"email":"john.doe1@example.com","contactID":1929391,"success":1,"inserted":1,"updated":0,"errors":[]},{"email":"john.doe2","contactID":"","success":0,"inserted":0,"updated":0,"errors":["Invalid email address [john.doe2]"]},{"email":"jane.doe@example.com","contactID":1929393,"success":1,"inserted":0,"updated":1,"errors":[]}]},"code":0,"requestID":"1E0419AB-B27A-465B-9CE24BF9F2DC06C8"}

Import With Custom Fields

POST

/contacts/import

cURL

Copy

curl https://api.emailer.emfluence.com/v1/contacts/import \
	-H "Authorization: Bearer {{accessToken}}" \
	-H "Content-Type: application/json" \
	-X POST \
	-d '{
		"contacts": [
			{"email":"john.doe1@example.com","firstName":"John","lastName":"Doe",
				"customFields":{
					"custom1":{
						"value":"Male"
					},
					"custom2":{
						"value":"2015-04-16"
					}
				}
			},
			{"email":"john.doe2@example.com","firstName":"John","lastName":"Doe II",
				"customFields":{
					"custom1":{
						"value":"Male"
					},
					"custom2":{
						"value":"2014-10-03"
					}
				}

			},
			{"email":"jane.doe@example.com","firstName":"Jane","lastName":"Doe",
				"customFields":{
					"custom1":{
						"value":"Female"
					},
					"custom2":{
						"value":"2015-01-19"
					}
				}
			}
		]
	}'

Response Data

{"extrainfo":"Duplicate emails are removed from the imported data (first occurrence is used).","success":1,"data":{"recordsInserted":2,"recordsInData":3,"recordsUpdated":1,"contactResults":[{"email":"john.doe1@example.com","contactID":1929391,"success":1,"inserted":1,"updated":0,"errors":[]},{"email":"john.doe2@example.com","contactID":1929392,"success":1,"inserted":1,"updated":0,"errors":[]},{"email":"jane.doe@example.com","contactID":1929393,"success":1,"inserted":0,"updated":1,"errors":[]}]},"code":0,"requestID":"020C4ABA-7D75-443F-920A6422C9FD59EA"}

API Console

The console uses production data, so BE CAREFUL!

POST

contacts/import

Request Body

{"groupIDs":"","updateExisting":"1","removeGroupIDs":"","contacts":[]}

Access token: *