Find here the list of actions to apply on the objects, and the data reference for this object.

What is a contact ?

A contact is a person, with a first name, last name, and contact data (phones, emails, etc). A contact can be linked to a firm.

Getting the contacts list

GET /contacts.xml

Returns all contacts, page by page
Add a page parameter to navigate

Getting a single contact

GET /contacts/#{id}.xml

Returns a single contact, identified by its id

Creating a new contact

POST /contacts.xml

Creates a new contact, and returns the contact data

Updating an existing contact

PUT /contacts/#{id}.xml

Updates some fields of an existing contact

Deleting an existing contact

DELETE /contacts/#{id}.xml

Deletes the contact identified by its id

Object data

<contact>
<id>id of contact</id>
<civility_label_id>civility (see below)</civility_label_id>
<last_name>last name</last_name>
<first_name>first name</first_name>
<comment>comment</comment>
<job_title>job title</job_title>
<job_department>department in company</job_department>
<country>France</country>
<contact_type>type of contact (see below)</contact_type>
<firm_id>id of firms the contact belongs to</firm_id>
<contact_addresses>
 <contact_address>
  <address_type>type of address (see below)</address_type>
  <street_address>street address</street_address>
  <street_address2>more address</street_address2>
  <zip_code>zip code</zip_code>
  <city>city</city>
  <country>France</country>
 </contact_address>
</contact_addresses>
<contact_items>
 <contact_item>
  <type_id>type of contact_item (see below)</type_id>
  <value>tel, email, etc.</value>
 </contact_item>
</contact_items>
</contact>

Possible values of client/firm type

• client for a client

• prospect for a prospect

• supplier for a supplier

• press for a journalist

• partner for a partner

• staff for a staff member or potential member

• perso for a personal contact

• other for none of the above

Possible values of civility_label_id

• 17 for a Mr

• 18 for a Madam

• 19 for a Miss

Possible values of contact_item_type

• 20 for a personal address

• 21 for a professional address

• 22 for a none of above

Possible values of contact_address_type for contacts

• 23 for a personal phone

• 25 for a personal fax

• 28 for a personal email

• 554 for a personal cell phone

• 471 for a main professional phone

• 24 for a professional phone

• 26 for a professional fax

• 27 for a professional email

• 88 for a professional cell phone

• 430 for a Skype address

• 431 for a Yahoo messenger id

• 432 for a MSN messenger id

• 433 for a AIM messenger id

• 457 for a ICQ messenger id