Deletes one or more contacts from the owner's address book. Cannot delete contacts shared by Teamraiser team members.
| Client Servlet | Server Servlet | HTTP Methods Supported | Requires Authentication |
|---|---|---|---|
| CRAddressBookAPI | None. | GET, POST | Yes. |
A constituent's Address Book is shared across several applications in Luminate Online, including TeamRaiser, Personal Fundraising, and Personal Events.
A TeamRaiser Participant who is also a Personal Fundraising Champion will see the same contacts in their Address Book when they are sending mail through their Participant Center or their Champion Center.
This method can be used to remove contacts from the constituent's address book. However, it cannot delete contacts that are shared between Teamraiser Team members (such as a donor that gave a gift on behalf of the team) - in order to delete those contacts, you must use the TeamRaiser API's deleteTeamraiserAddressBookContacts method.
See topic Common Parameters.
Optional. Comma-separated list of contact IDs to delete.
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"?>
<deleteAddressBookContactsResponse 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">
<contactId>101</contactId>
<contactId>102</contactId>
<contactId>103</contactId>
<errors>false</errors>
</deleteAddressBookContactsResponse>
JSON response
{"deleteAddressBookContactsResponse":{"errors":"false","contactId":["101","102","103"]}}