For a given list of contacts in CSV format ("first name", "last name", "email address") this REST method will: 1) Add and return new contacts that don't match email, first name or last name 2) Return a list of potential duplicate contacts that match either email OR first and last name 3) Return a list of full duplicate contacts that match email, first name and last name 4) Return a list of contacts that could not be added due to errors
| Client Servlet | Server Servlet | HTTP Methods Supported | Requires Authentication |
|---|---|---|---|
| CRAddressBookAPI | None. | GET, POST | Yes. |
Like addAddressBookContacts, this method allows you to add contacts to the logged-in constituent's address book, but returns a different response structure and provides a higher degree of duplicate and error checking.
For a supplied list of addresses, this method returns: a list of new contacts, a list of potential duplicates, a list of duplicates, and a list of any contacts that could not be added due to errors (e.g. email address validation failure).
See topic Common Parameters.
Required. Comma-separated list of names and addresses. e.g. "Bob Smith" <bob@example.com>, "Kelly Smith" <kelly@example.com>
Type xsd:string.
Optional. You must provide either this parameter or the sso_auth_token parameter. If using this parameter, you must specify an auth token generated by an embedded [[S86]] session tag in a Convio web page.
Optional. You must provide either this parameter or the auth parameter. If using this parameter, you must specify a valid session authentication token returned by login, authenticateUser, or getSingleSignOnToken.
See topic HTTP Status Codes.
XML response
<?xml version="1.0" encoding="UTF-8"?>
<importAddressBookContactsResponse xsi:schemaLocation="http://convio.com/crm/v1.0 http://service.convio.net/xmlschema/crm.public.v1.xsd" xmlns="http://convio.com/crm/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<savedContact>
<contact>
<id>1001001</id>
<firstName>Eric</firstName>
<lastName>Ericson</lastName>
<email>eericson@address.net</email>
</contact>
</savedContact>
<savedContact>
<contact>
<id>1001002</id>
<firstName>Frank</firstName>
<lastName>Franklin</lastName>
<email>ffranklin@address.net</email>
</contact>
</savedContact>
<duplicateContact>
<contact>
<firstName>Adam</firstName>
<lastName>Adams</lastName>
<email>aadams@address.net</email>
</contact>
<duplicateContact>
<id>1001</id>
<firstName>Adam</firstName>
<lastName>Adams</lastName>
<email>aadams@address.net</email>
</duplicateContact>
</duplicateContact>
<duplicateContact>
<contact>
<firstName>Brian</firstName>
<lastName>Brians</lastName>
<email>bbrians@address.net</email>
</contact>
<duplicateContact>
<id>1002</id>
<firstName>Brian</firstName>
<lastName>Brians</lastName>
<email>bbrians@address.net</email>
</duplicateContact>
</duplicateContact>
<potentialDuplicateContact>
<contact>
<firstName>Charlie</firstName>
<lastName>Charles</lastName>
<email>ccharles@address.net</email>
</contact>
<duplicateContact>
<id>1003</id>
<firstName>Charlie</firstName>
<lastName>Charles</lastName>
<email>ccharlessomeotheraddress.net</email>
</duplicateContact>
</potentialDuplicateContact>
<potentialDuplicateContact>
<contact>
<firstName>David</firstName>
<lastName>Davidson</lastName>
<email>ddavidson@address.net</email>
</contact>
<duplicateContact>
<id>1004</id>
<firstName>Other</firstName>
<lastName>Name</lastName>
<email>ddavidson@address.net</email>
</duplicateContact>
</potentialDuplicateContact>
<errorContact>
<contact>
<firstName>Greg</firstName>
<lastName>Gregory</lastName>
<email>ggreg@address</email>
</contact>
<error>ggreg@address is not a valid email address</error>
</errorContact>
</importAddressBookContactsResponse>
JSON response
{"importAddressBookContactsResponse":{"potentialDuplicateContact":[{"duplicateContact":{"id":"1003","lastName":"Charles","email":"ccharlessomeotheraddress.net","firstName":"Charlie"},"contact":{"lastName":"Charles","email":"ccharles@address.net","firstName":"Charlie"}},{"duplicateContact":{"id":"1004","lastName":"Name","email":"ddavidson@address.net","firstName":"Other"},"contact":{"lastName":"Davidson","email":"ddavidson@address.net","firstName":"David"}}],"savedContact":[{"contact":{"id":"1001001","lastName":"Ericson","email":"eericson@address.net","firstName":"Eric"}},{"contact":{"id":"1001002","lastName":"Franklin","email":"ffranklin@address.net","firstName":"Frank"}}],"errorContact":{"error":"ggreg@address is not a valid email address","contact":{"lastName":"Gregory","email":"ggreg@address","firstName":"Greg"}},"duplicateContact":[{"duplicateContact":{"id":"1001","lastName":"Adams","email":"aadams@address.net","firstName":"Adam"},"contact":{"lastName":"Adams","email":"aadams@address.net","firstName":"Adam"}},{"duplicateContact":{"id":"1002","lastName":"Brians","email":"bbrians@address.net","firstName":"Brian"},"contact":{"lastName":"Brians","email":"bbrians@address.net","firstName":"Brian"}}]}}