Luminate Online

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

Client API Syntax

https://secure2.convio.net/organization/site/CRAddressBookAPI?method=addAddressBookGroup &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_name=value [ &contact_ids=value ] [ &auth=value ] [ &sso_auth_token=value ]

Client API Parameters

Common Client Parameters

See topic Common Parameters.

group_name

Required. The name of the group.

Type xsd:string.

contact_ids

Optional. Optional comma-separated list of contact IDs to add to the new 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 Convio 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"?>
<addAddressBookGroupResponse 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>Sample Group Name</name>
  </addressBookGroup>
</addAddressBookGroupResponse>

JSON response

{"addAddressBookGroupResponse":{"addressBookGroup":{"id":"123","name":"Sample Group Name"}}}

addAddressBookGroup

Client API Syntax

Client API Parameters

Response

Leave a Comment