Deletes one or more Address Book groups.
| Client Servlet | Server Servlet | HTTP Methods Supported | Requires Authentication |
|---|---|---|---|
| CRAddressBookAPI | None. | POST | Yes. |
Given one or more group_id values, this method will delete the Address Book groups specified by the IDs. Deleting a group does not delete the group's member contacts. To delete contacts, use deleteAddressBookContacts.
See topic Common Parameters.
Required. Comma-separated list of group IDs.
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"?>
<removedAddressBookGroupResponse 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">
<group_id>123</group_id>
<group_id>234</group_id>
</removedAddressBookGroupResponse>
JSON response
{"removedAddressBookGroupResponse":{"group_id":["123","234"]}}