Client API Parameters

Common Client Parameters

See topic Common Parameters.

contacts_to_add

Required. Comma-separated list of names and addresses. e.g. "Bob Smith" <bob@example.com>, "Kelly Smith" <kelly@example.com>

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"?>
<getAddressBookContactsResponse 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">
  <addressBookContact>
    <id>100</id>
    <firstName>User0First</firstName>
    <lastName>User0Last</lastName>
    <email>user0@example.com</email>
    <group>
      <id>200</id>
      <name>Group 0</name>
    </group>
    <group>
      <id>200</id>
      <name>Group 0</name>
    </group>
  </addressBookContact>
  <addressBookContact>
    <id>101</id>
    <firstName>User1First</firstName>
    <lastName>User1Last</lastName>
    <email>user1@example.com</email>
    <group>
      <id>201</id>
      <name>Group 1</name>
    </group>
  </addressBookContact>
</getAddressBookContactsResponse>

        

{"getAddressBookContactsResponse":{"addressBookContact":[{"id":"100","lastName":"User0Last","email":"user0@example.com","group":[{"id":"200","name":"Group 0"},{"id":"200","name":"Group 0"}],"firstName":"User0First"},{"id":"101","lastName":"User1Last","email":"user1@example.com","group":{"id":"201","name":"Group 1"},"firstName":"User1First"}]}}