Deletes one or more contacts from the owner's address book, including contacts shared by team members. Shared contacts are not deleted from team members Address Books, only from the owner's address book.
| Client Servlet | Server Servlet | HTTP Methods Supported | Requires Authentication |
|---|---|---|---|
| CRTeamraiserAPI | None. | GET, POST | Yes. |
Similar to the Address Book API's deleteAddressBookContacts method, this method allows you to remove contacts from a constituent's Address Book.
The primary difference between this method and deleteAddressBookContacts is that this method requires the fr_id of the event the participant is currently working in, and is capable of removing contacts shared by team members.
When removing a contact that is shared by team members (such as a Team donor, or another team member) the removal affects only the currently logged in participant - the rest of the team will continue to see the contact in their address book (depending on site configuration).
See topic Common Parameters.
Required. The TeamRaiser event ID.
Type xsd:nonNegativeInteger.
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"?>
<deleteTeamraiserAddressBookContactsResponse 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>
</deleteTeamraiserAddressBookContactsResponse>
JSON response
{"deleteTeamraiserAddressBookContactsResponse":{"errors":"false","contactId":["101","102","103"]}}