Contact
An object that represents a contact in BlueCamroo. Contacts are child objects of Organization objects. A Contact is associated with a Person object.
Supported API Calls: Get | Add | Update | Delete
Object Properties
| Property | Type | Description | 
| AccountId | integer | The ID of the parent Organization object. | 
| JobTitle | string (100) | Text for the contact's's Job Title field. | 
| Department | integer | ID to set the contact's Department drop-down box. Value should be equal to a Department object's ID field. | 
| Description | string (100) | Text for the contact's's Description field. | 
| OwnerId | integer | ID of the internal user owner. | 
| IsActive | boolean | Flag to indicate the contact is active in BlueCamroo. | 
| IsLocked | boolean | Flag to indicate the contact cannot be edited. This property is read only | 
| LanguageLocaleKey | string (100) | What the display language should be used for this user. Use ISO standard language codes. For example en-US. | 
| TimeZoneKey | string (100) | Which time zone should be used for this user. Use Microsoft Name of Time Zone values. For example, Dateline Standard Time. | 
| IsPrimary | boolean | Flag to indicate this contact is the primary contact. | 
| ReceiveInvoiceEmail | boolean | Flag to indicate this contact is the that receives invoices. | 
| CreatedBy | integer | ID of the user who created this contact. Read only. | 
| CreationDate | DateTime | Indicates when this object was created. Read only. | 
| LastModifiedBy | integer | ID of the user who last modified the object. Read only. | 
| LastModifiedDate | DateTime | Date the last time the object was modified. Read only. | 
| LastActivityDate | DateTime | Date the last time the object was accessed in any way. Read only. | 
| StartDate | DateTime | Date the contact started with the organization. | 
| EndDate | DateTime | Date the contact ended association with the organization. | 
| Person | Person | The person object associated with this contact. | 
| EmailAddressList | List<EmailAddress> | A contact object can be associated with multiple email addresses. The contact's email addresses are stored as a list of EmailAddress objects. | 
| PhoneList | List<Phone> | A contact object can be associated with multiple phone numbers. The contact's phone numbers are stored as a list of phone objects. | 
| SocialNetworkProfileList | List<SocialNetworkProfile> | A contact object can be associated with multiple social profiles. The contact's social profiles are stored as a list of SocialNetworkProfile objects. | 
| ContactLinkList | List<ContactLink> | A list of ContactLinks. Links store the contact object's Location, Customer Contact, and Supplier Contact details. | 
| CustomerContact | boolean | Flag to indicate this contact is the primary contact. | 
| SupplierContact | boolean | Flag to indicate this contact is the primary supplier contact. | 
| ProfileImage | string (100) | An HTTP URL to the profile image. | 
| Invited | boolean | Flag to indicate this contact record has been invited as an external user. | 
Get
Description
Returns the specified contact object.
URL
https://{company}.bluecamroo.com/api/contact/get/{id}
HTTP Method
GET
Data Return
Returns the contact object in the requested format (e.g., JSON or XML)
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Add
Description
Adds the contact object to the list of contacts
URL
https://{company}.bluecamroo.com/api/contact/add
HTTP Method
POST
Parameters
A contact object
Data Return
Returns the contact object in the requested format (e.g., JSON or XML)
HTTP Return Status Code
201: Created
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Update
Description
Pass a contact object to replace the specified contact.
URL
https://{company}.bluecamroo.com/api/contact/update
HTTP Method
PUT
Parameters
A contact object
Data Return
Returns the contact object in the requested format (e.g., JSON or XML)
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Delete
Description
Deletes the specified contact
URL
https://{company}.bluecamroo.com/api/contact/delete/{id}
HTTP Method
DELETE
Parameters
None
Data Return
None
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
|   | 
