addAddressBookContact

Adds a single contact to your address book.

Client ServletServer ServletHTTP Methods SupportedRequires Authentication
CRAddressBookAPI $method.getServerServlet() GET, POST Yes.

Client API Syntax

https://secure2.convio.net/organization/site/CRAddressBookAPI?method=addAddressBookContact &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 ] &email=value [ &first_name=value ] [ &last_name=value ] [ &auth=value ] [ &sso_auth_token=value ]

Server API Syntax

https://secure2.convio.net/organization/site/$method.getServerServlet()?method=addAddressBookContact & api_key =value & login_name =value & login_password =value & v =value [ & center_id =value ] [ & response_format =xml |json ] [ & source =value ] [ & sub_source =value ] [ & suppress_response_codes =value ] & email =value [ & first_name =value ] [ & last_name =value ] & cons_id =value

Client API Parameters

Common Client Parameters

See topic Common Parameters.

email

Required. The contact's email address.

Type xsd:string.

first_name

Optional. The contact's first name.

Type xsd:string.

last_name

Optional. The contact's last name.

Type xsd:string.

Server API Parameters

Common Server Parameters

See topic Common Parameters.

email

Required. The contact's email address.

Type xsd:string.

first_name

Optional. The contact's first name.

Type xsd:string.

last_name

Optional. The contact's last name.

Type xsd:string.

cons_id

Required. The system-generated unique constituent ID of the owner of the contact record.

Type xsd:nonNegativeInteger.

Response

See topic HTTP Status Codes.

XML response 
<?xml version="1.0" encoding="UTF-8"?>
<addAddressBookContactResponse 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>101</id>
    <firstName>User1First</firstName>
    <lastName>User1Last</lastName>
    <email>user1@example.com</email>
    <group>
      <id>201</id>
      <name>Group 1</name>
    </group>
  </addressBookContact>
</addAddressBookContactResponse>
JSON response 
{"addAddressBookContactResponse":{"addressBookContact":{"firstName":"User1First","lastName":"User1Last","id":"101","email":"user1@example.com","group":{"name":"Group 1","id":"201"}}}}
Parent topic: Address Book API
Next topic: addAddressBookContacts

Leave a Comment

Nickname
Comment
Enter this word:
Change