updateAddressBookGroup

This method is used to update an existing Address Book group.

Client Servlet	Server Servlet	HTTP Methods Supported	Requires Authentication
CRAddressBookAPI	None.	POST	Yes.

Client API Syntax

https://secure2.convio.net/organization/site/CRAddressBookAPI?method=updateAddressBookGroup &api_key=value &v=value [ &auth=value ] [ &center_id=value ] [ &error_redirect=value ] [ &redirect=value ] [ &response_format=xml | json ] [ &sign_redirects=value ] [ &source=value ] [ &sub_source=value ] [ &success_redirect=value ] [ &suppress_response_codes=value ] &group_id=value &group_name=value [ &auth=value ] [ &sso_auth_token=value ]

Usage Notes

Use this method to change the name of the address book group specified by group_id.

Client API Parameters

Common Client Parameters: See topic Common Parameters.
group_id: Required. A unique ID of the group being added.
Type xsd:nonNegativeInteger.
group_name: Required. The name of the group.
Type xsd:string.
auth: 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 Luminate Online web page.
sso_auth_token: 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.

Response

See topic HTTP Status Codes.

XML response

<?xml version="1.0" encoding="UTF-8"?>
<updateAddressBookGroupResponse 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">
   <addressBookGroup>
      <id>123</id>
      <name>Updated Group Name</name>
   </addressBookGroup>
</updateAddressBookGroupResponse>

JSON response

JSON

{
    "updateAddressBookGroupResponse": {
        "addressBookGroup": {
            "name": "Updated Group Name",
            "id": "123"
        }
    }
}