Client API Parameters

Common Client Parameters

See topic Common Parameters.

group_id

Required. A unique ID of the group to add contacts to.

Type xsd:nonNegativeInteger.

contact_ids

Optional. Comma-separated list of contact IDs to add to the specified 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 version="1.0" encoding="UTF-8"?>
<addContactsToGroupResponse 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>
  <contactId>100</contactId>
  <contactId>101</contactId>
  <contactId>102</contactId>
  <contactId>103</contactId>
  <contactId>104</contactId>
</addContactsToGroupResponse>

        

{"addContactsToGroupResponse":{"contactId":["100","101","102","103","104"],"addressBookGroup":{"id":"123","name":"Sample Group Name"}}}