Person

An object representing a person or a lead.

Supported API Calls: Get | Add | Update | Delete

Object Properties

Property

Type

Description

FirstName

string (100)

First name of the person represented by the object.

LastName

string (100)

Last name of the person represented by the object.

Salutation

integer

Represents the person's title (Mr., Mrs., etc.). Reference the lookup value salutation ID.

Industry

integer

ID to set the person's industry drop-down box. Value should be equal to an industry object's ID field.

Sector

integer

ID to set the person's sector drop-down box. Value should be equal to an sector object's ID field.

PriceBookId

integer

The ID of a pricebook object.

OwnerId

integer

The ID of the user who owns this object.

IsLocked

boolean

Flag to indicate this person is available in BlueCamroo but cannot be edited. This property is read only

InMailingList

boolean

Flag to indicate if this person is allowed to be in an email marketing email list.

LanguageLocaleKey

string (100)

Represents the contents of the Regional Setting's Language field.

TimeZoneKey

string (100)

Represents the contents of the Regional Setting's Time Zone field.

Source

string (100)

ID to set the person's Source drop-down box. Value should be equal to a Source object's ID field.

ProfileImage

string (100)

HTTP Link to the person id's profile image

CreatedBy

integer

ID of the internal user who created this object. 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.

EmailAddressList

List<EmailAddress>

A person object can be associated with multiple email addresses. The person's email addresses are stored as a list of EmailAddress objects.

AddressList

List<Address>

A person object can be associated with multiple addresses. The person's addresses are stored as a list of Address objects.

SocialNetworkProfileList

List<SocialNetworkProfile>

A person object can be associated with multiple social profiles. The person's social profiles are stored as a list of SocialNetworkProfile objects.

IsLead

boolean

Flag to indicate this object is treated as a lead in BlueCamroo.

LeadId

integer

If the person is flagged a lead, this represents the person's lead ID.

IsCustomer

boolean

Flag to indicate this object is treated as a customer in BlueCamroo.

CustomerId

integer

If the person is flagged a customer, this represents the person's customer ID.

IsSupplier

boolean

Flag to indicate this object is treated as a supplier in BlueCamroo.

SupplierId

integer

If the person is flagged a supplier, this represents the person's supplier ID.

LeadAge

integer

If this person is a lead, the number of days the person has been a lead.

Get

Description

Returns the specified person.

URL

https://{company}.bluecamroo.com/api/person/get/{id}

HTTP Method

GET

Parameters

None

Data Return

Returns the person object in the requested format (e.g., JSON or XML)

HTTP Return Status Code

200: OK

401: Not authorized (you need to log in)

403: Forbidden (you don't have permission to this resource)

Add

Description

Adds a person. Adds a person by passing a person object.

URL

https://{company}.bluecamroo.com/api/person/add

HTTP Method

POST

Parameters

A person object

Data Return

Returns the Person 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 person object to replace one or more person details with the matching value.

URL

https://{company}.bluecamroo.com/api/person/update

HTTP Method

PUT

Parameters

A person object

Data Return

Returns the Person 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 person based on the passed ID number.

URL

https://{company}.bluecamroo.com/api/person/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)