The AddContactsToAddressBookWithProgress method allows you to add multiple contacts to an address book within the dotMailer system. It allows you to track the progress of the import by returning a GUID which you can use to query the import progress.
This method is useful when you need to upload multiple contacts in one go into the dotMailer system. As each call only counts as one API call it allows you to easily stay below your API limit whilst uploading multiple contacts. It has the benefit of being run through our data watchdog so you know the data you are importing is of a good quality.
It will return a GUID which you can use to check the progress of your import. This is useful if you want to perform an action on the address book when the import has finished.
This method will create the contact being added if it doesn't already exist which means you do not need to call a method such as CreateContact before calling it. You may upload either a .csv or .xls file. It must contain one column with the heading "Email" or the translated equivalent if your account is using a language other than English. Other columns will attempt to map to your custom data fields. There is a 10MB file upload limit; if your file is larger than this, please break your upload into separate files.
As the import goes through our data watchdog there might be a delay between uploading the contacts and them being successfully added to the address book.
To query the progress of the import please call GetContactImportProgress using the GUID returned by AddContactsToAddressBookWithProgress.
||This is the username from your API key. It is in the format of an email address and will look similar to email@example.com
||This is the password from your API key.
||This is the ID of the address book which you would like to upload the contacts to.
||This is the original file, encoded in Base64 format.
||CSV or XLS
||This is the type of file which you are uploading, either .CSV, or .XLS. At this time, XLSX is not supported.