Resource Definitions:Contacts

From API Documentation

Revision as of 02:37, 22 July 2010 by WikiSysop (Talk | contribs)
Jump to: navigation, search

The contacts resource is a collection of all contacts associated with your agent account.

Example URI: http://api.rezora.com/v1/contacts

Available methods are:

Contents

GET

Returns a list of contacts. Each contact record includes the following fields:

  • contact_id
  • contact_name
  • contact_email
  • contact_type (possible values are: Hot, Active, Inactive, [empty string = no type])
  • contact_title
  • contact_company
  • contact_phone_home
  • contact_phone_work
  • contact_phone_mobile
  • contact_phone_fax
  • contact_business_street
  • contact_business_street2
  • contact_business_city
  • contact_business_state
  • contact_business_zip
  • contact_home_street
  • contact_home_street2
  • contact_home_city
  • contact_home_state
  • contact_home_zip
  • contact_date
  • contact_self

Example Responses

XML Response

<?xml version="1.0" encoding="UTF-8"?>
<contacts version="1.0">
 <contact>
  <contact_id>123456</contact_id>
  <contact_name>Jane Smith</contact_name>
  <contact_email>jane.smith@company.com</contact_email>
  <contact_type>Active</contact_type>
  <contact_title>Consultant</contact_title>
  <contact_company>Acme Consulting</contact_company>
  <contact_phone_home>303-555-1234</contact_phone_home>
  <contact_phone_work>303-555-1235</contact_phone_work>
  <contact_phone_mobile>303-555-1236</contact_phone_mobile>
  <contact_phone_fax>303-555-1237</contact_phone_fax>
  <contact_business_street>123 Church Street</contact_business_street>
  <contact_business_street2>Suite 12</contact_business_street2>
  <contact_business_city>Shady Acres</contact_business_city>
  <contact_business_state>CO</contact_business_state>
  <contact_business_zip>12345</contact_business_zip>
  <contact_home_street>124 Church Street</contact_home_street>
  <contact_home_street2></contact_home_street2>
  <contact_home_city>Shady Acres</contact_home_city>
  <contact_home_state>CO</contact_home_state>
  <contact_home_zip>12345</contact_home_zip>
  <contact_date>2010-07-16 22:34:01</contact_date>
  <contact_self>0</contact_self>
 </contact>
 ...
</contacts>

JSON Response

[
 {
  "contact_id":"123456",
  "contact_name":"Jane Smith",
  "contact_email":"jane.smith@company.com",
  "contact_type":"Active",
  "contact_title":"Consultant",
  "contact_company":"Acme Consulting",
  "contact_phone_home":"303-555-1234",
  "contact_phone_work":"303-555-1235",
  "contact_phone_mobile":"303-555-1236",
  "contact_phone_fax":"303-555-1237",
  "contact_business_street":"123 Church Street",
  "contact_business_street2":"Suite 12",
  "contact_business_city":"Shady Acres",
  "contact_business_state":"CO",
  "contact_business_zip":"12345",
  "contact_home_street":"124 Church Street",
  "contact_home_street2":"",
  "contact_home_city":"Shady Acres",
  "contact_home_state":"CO",
  "contact_home_zip":"12345",
  "contact_date":"2010-07-16 22:34:01",
  "contact_self":"0"
 }
 ...
]

TEXT (pipe-delimited)

"contact_id"|"contact_name"|"contact_email"|"contact_type"|"contact_title"|"contact_company"|"contact_phone_home"|"contact_phone_work"|"contact_phone_mobile"|"contact_phone_fax"|"contact_business_street"|"contact_business_street2"|"contact_business_city"|"contact_business_state"|"contact_business_zip"|"contact_home_street"|"contact_home_street2"|"contact_home_city"|"contact_home_state"|"contact_home_zip"|"contact_date"|"contact_self"
"123456"|"Jane Smith"|"jane.smith@company.com"|"Active"|"Consultant"|"Acme Consulting"|"303-555-1234"|"303-555-1235"|"303-555-1236"|"303-555-1237"|"123 Church Street"|"Suite 12"|"Shady Acres"|"CO"|"12345"|"124 Church Street"|""|"Shady Acres"|"CO"|"12345"|"2010-07-16 22:34:01"|"0"
...

POST

Adds a new contact, and returns the new contact ID. You may include the following fields (required fields marked with a red asterisk (*)):

  • contact_name
  • contact_email * (must be a valid email address; must be unique: if already exists, an error will be returned)
  • contact_type (accepted values are: Hot, Active, Inactive, [empty string = no type])
  • contact_title
  • contact_company
  • contact_phone_home
  • contact_phone_work
  • contact_phone_mobile
  • contact_phone_fax
  • contact_business_street
  • contact_business_street2
  • contact_business_city
  • contact_business_state
  • contact_business_zip
  • contact_home_street
  • contact_home_street2
  • contact_home_city
  • contact_home_state
  • contact_home_zip

Example Request Data

XML Request

<?xml version="1.0" encoding="UTF-8"?>
<data>
 <contact_name>Jane Smith</contact_name>
 <contact_email>jane.smith@company.com</contact_email>
 <contact_type>Active</contact_type>
 <contact_title>Consultant</contact_title>
 <contact_company>Acme Consulting</contact_company>
 <contact_phone_home>303-555-1234</contact_phone_home>
 <contact_phone_work>303-555-1235</contact_phone_work>
 <contact_phone_mobile>303-555-1236</contact_phone_mobile>
 <contact_phone_fax>303-555-1237</contact_phone_fax>
 <contact_business_street>123 Church Street</contact_business_street>
 <contact_business_street2>Suite 12</contact_business_street2>
 <contact_business_city>Shady Acres</contact_business_city>
 <contact_business_state>CO</contact_business_state>
 <contact_business_zip>12345</contact_business_zip>
 <contact_home_street>124 Church Street</contact_home_street>
 <contact_home_street2></contact_home_street2>
 <contact_home_city>Shady Acres</contact_home_city>
 <contact_home_state>CO</contact_home_state>
 <contact_home_zip>12345</contact_home_zip>
</data>

JSON Request

{
 "data":{
  "contact_name":"Jane Smith",
  "contact_email":"jane.smith@company.com",
  "contact_type":"Active",
  "contact_title":"Consultant",
  "contact_company":"Acme Consulting",
  "contact_phone_home":"303-555-1234",
  "contact_phone_work":"303-555-1235",
  "contact_phone_mobile":"303-555-1236",
  "contact_phone_fax":"303-555-1237",
  "contact_business_street":"123 Church Street",
  "contact_business_street2":"Suite 12",
  "contact_business_city":"Shady Acres",
  "contact_business_state":"CO",
  "contact_business_zip":"12345",
  "contact_home_street":"124 Church Street",
  "contact_home_street2":"",
  "contact_home_city":"Shady Acres",
  "contact_home_state":"CO",
  "contact_home_zip":"12345"
 }
}

TEXT Request (uri-encoded)

contact_name=Jane+Smith&contact_email=jane.smith%40company.com&contact_type=Active&contact_title=Consultant&contact_company=Acme+Consulting&contact_phone_home=303-555-1234&contact_phone_work=303-555-1235&contact_phone_mobile=303-555-1236&contact_phone_fax=303-555-1237&contact_business_street=123+Church+Street&contact_business_street2=Suite+12&contact_business_city=Shady+Acres&contact_business_state=CO&contact_business_zip=12345&contact_home_street=124+Church+Street&contact_home_street2=&contact_home_city=Shady+Acres&contact_home_state=CO&contact_home_zip=12345

Example Response Data

XML Response

<?xml version="1.0" encoding="UTF-8"?>
<contacts version="1.0">
 <contact>
  <contact_id>123456</contact_id>
 </contact>
</contacts>

JSON Response

[
 {
  "contact_id":"123456"
 }
]

TEXT Response (pipe-delimited)

contact_id
123456

DELETE

Permanently removes ALL contacts, and returns a success code.

Example Response Data

XML Response

<?xml version="1.0" encoding="UTF-8"?>
<contacts version="1.0">
 <contact>
  <status>200</status>
 </contact>
</contacts>

JSON Response

[
 {
  "status":"200"
 }
]

TEXT Response (pipe-delimited)

status
200
Personal tools