{"_id":"5cc17d30b229b1004a73d1ee","project":"55dd9f2e0efd5821000d54d9","version":{"_id":"55dd9f4dab0e4d210045aae9","__v":45,"project":"55dd9f2e0efd5821000d54d9","createdAt":"2015-08-26T11:13:17.024Z","releaseDate":"2015-08-26T11:13:17.024Z","categories":["55dd9f4dab0e4d210045aaea","55ddb5fa9067202b00ddff6f","55e0472c6bad670d0081f213","55e04764a44fae0d00214671","55e047a9a44fae0d00214672","55e047b258c5460d0076a9a7","55e95e337fc27b2d00d32cf2","55e979bda7ca823900ad549a","55edb8c18dcb210d0056900b","55f0365c8563861700a33765","55f03677d58f9b1900acf996","55f036938eeefc23001ea5de","55f036a38563861700a33767","55f036c08563861700a33769","55f036d02911b72100482cd7","55f036e92911b72100482cd9","55f036fa8563861700a3376b","55f0370ee507711900e58c69","55f0371df6101b1900c70700","55f0374f2911b72100482cdb","55f0375e2911b72100482cdc","560eb0f659cb8d0d0015cd52","560eb25239fad419002ae1e0","561fb64d4d67490d00804b2a","562b9f775a39cd0d009aff22","562ba0505a39cd0d009aff23","562ba149d56bc30d00f0cb18","562ba595f68a5f0d007b1f3b","562ba78fd56bc30d00f0cb1b","562ba8b95a39cd0d009aff27","562baadf6562140d001501d2","562bab37f68a5f0d007b1f3d","562bc1bf9ebc950d000f7523","562bc99ced4bea0d00c11dfa","562bd29c1b98640d00714520","562bd5875a39cd0d009aff60","562bdfabff2da50d002c0aaf","562be0bd5a39cd0d009aff75","57a0b476d8313e1900454439","5b19051beece890003020163","5b34ded01cb20f000391ad6d","5b3a325acffe770003fd29e5","5b3c737a7f7b890003365501","5b3c929b367036000391b11e","5b7c1e210dc2e20003871521"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"category":{"_id":"55e047b258c5460d0076a9a7","__v":24,"project":"55dd9f2e0efd5821000d54d9","version":"55dd9f4dab0e4d210045aae9","pages":["55ed71142bdb6a2d0064f216","55ed71e1a872a80d00acff1a","55ed72a8df21af2b009e215f","55ef03aae7f5490d000c0dfd","55f1872e5fe76419007dc703","55f2af86d1c4c7170033df2b","55f2d812525cb12300c6c517","55f2db08c93a2d230062f971","55f2deaacb01c71900c8e218","55f2e024fb7aad2300bf1823","55f2e1f6525cb12300c6c554","55f2e47ffb7aad2300bf182b","55f2ea90525cb12300c6c56c","55f2ed9ecb01c71900c8e24a","55f2f26f71c6462100e0fdf1","55f2f2e3c93a2d230062f9af","55f2f3bdc93a2d230062f9b1","55fc1d6ae013770d008fcbf3","55fc249ff4dbbf0d008f43ef","55fc2bd3e013770d008fcc0b","55ffda3d8c0c9d0d00dcacb4","55ffdf828c0c9d0d00dcacba","55ffe1a56932a00d00ba7abc","560d322c3616cf0d00a8cc97"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-28T11:36:18.041Z","from_sync":false,"order":7,"slug":"contacts","title":"Contacts"},"user":"5c3740967267aa42020e5cce","__v":16,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-04-25T09:26:08.985Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":202,"language":"json","code":"{\n  \"id\": \"af4ac4bc-e1e7-4817-8a66-73fb59e91ce6\",\n  \"status\": \"NotFinished\"\n}","name":""}]},"settings":"","examples":{"codes":[{"code":"var url = \"v2/address-books/1/contacts/import/with-merge-option/1\";\nvar filePath = :::at:::\"FileName.csv\";\nusing (var multipartFormDataContent = new MultipartFormDataContent())\nusing (var fileContent = new ByteArrayContent(File.ReadAllBytes(filePath)))\nusing (var httpClient = new HttpClient())\n{\n  fileContent.Headers.ContentType = MediaTypeHeaderValue.Parse(\"text/csv\");\n  fileContent.Headers.ContentDisposition = new ContentDispositionHeaderValue(\"attachment\")\n    {\n      FileName = \"FileName.csv\",\n      DispositionType = DispositionTypeNames.Attachment,\n      Name = \"fileData\"\n    };\n  multipartFormDataContent.Add(fileContent);\n  httpClient.BaseAddress = new Uri(\"https://api.dotmailer.com\");\n  var credentials = Encoding.ASCII.GetBytes(\"username:password\");\n  httpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue(\"Basic\", Convert.ToBase64String(credentials));\n  var result = httpClient.PostAsync(url, multipartFormDataContent).Result;\n}","language":"csharp"}]},"method":"post","auth":"required","params":[{"_id":"5cc181c41a050f010d731547","ref":"","in":"path","required":true,"desc":"The ID of the address book, which needs to be included within the URL","default":"","type":"int","name":"ID"},{"_id":"5cc181c41a050f010d731546","ref":"","in":"path","required":true,"desc":"For merge options, you can update all data fields by entering '0', avoid updating data fields that contain blank values by entering '1', or you can choose not to update data fields that contain values by entering '2'","default":"","type":"int","name":"MergeOption"},{"_id":"5cc181c41a050f010d731545","ref":"","in":"body","required":true,"desc":"The CSV or Excel file to upload","default":"","type":"file","name":"FileData"}],"url":"/:version/address-books/[ID]/contacts/import/with-merge-option/{mergeOption}"},"isReference":false,"order":20,"body":"This operation bulk creates, or bulk updates, contacts with merge options. \n\nImport format can either be CSV or Excel. It must contain one column with the heading 'Email'. Passing a valid 'mergeOption' parameter is compulsory. Any other columns will attempt to map to your custom data fields. The ID of returned object can be used to query import progress.\n\nThis method mimics the existing [bulk create contacts in address book](https://developer.dotdigital.com/docs/bulk-create-contacts-in-address-book) method, but with an additional parameter, 'mergeOption', that allows you to specify how the import should handle empty fields, which is similar to the functionality described in [this article](https://support.dotdigital.com/hc/en-gb/articles/212211898-Importing-contacts-into-an-address-book#mergeoptions).","excerpt":"Bulk creates, or bulk updates, contacts in an address book with merge option","slug":"create-contact-with-merge-option","type":"endpoint","title":"Bulk create contacts in address book with merge option"}

postBulk create contacts in address book with merge option

Bulk creates, or bulk updates, contacts in an address book with merge option

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

ID:
required
integer
The ID of the address book, which needs to be included within the URL
MergeOption:
required
integer
For merge options, you can update all data fields by entering '0', avoid updating data fields that contain blank values by entering '1', or you can choose not to update data fields that contain values by entering '2'

Body Params

FileData:
required
file
The CSV or Excel file to upload

Examples


Result Format


Documentation

This operation bulk creates, or bulk updates, contacts with merge options. Import format can either be CSV or Excel. It must contain one column with the heading 'Email'. Passing a valid 'mergeOption' parameter is compulsory. Any other columns will attempt to map to your custom data fields. The ID of returned object can be used to query import progress. This method mimics the existing [bulk create contacts in address book](https://developer.dotdigital.com/docs/bulk-create-contacts-in-address-book) method, but with an additional parameter, 'mergeOption', that allows you to specify how the import should handle empty fields, which is similar to the functionality described in [this article](https://support.dotdigital.com/hc/en-gb/articles/212211898-Importing-contacts-into-an-address-book#mergeoptions).