Link

Contact

Contact in the requestJSON and responseJSON are in the form of List of Contact objects.

The Contact object has the following parameters.

Field NameData TypeDescription
salesforceIDIDRead-Only field, provides the Salesforce Record ID upon successful creation or updation in Salesforce.
addressbookListAddressBooks 
altEmailString 
assistantString 
commentsString 
companyLookupRecordInternal ID of the Company.
customFieldListCustomFieldsCustom fields and their values.
customFormLookupRecordInternal ID of the Custom Form.
dateCreatedLongRead-Only field, the Date will be returned as a Unix timestamp in seconds.
defaultAddressStringRead-Only field, Populates from AddressBooks
emailString 
entityIdStringThe Name of the Contact, populated from the First, Middle and Last Names
externalIdString 
faxString 
firstName*StringFirst Name of the Contact
homePhoneString 
internalIdString 
isInactiveBoolean 
isPrivateBoolean 
lastModifiedDateLongRead-Only field and the Date is returned as a Unix timestamp in seconds.
lastName*StringLast Name of the Contact
middleNameString 
mobilePhoneString 
officePhoneString 
phoneString 
salutationString 
subsidiary*LookupRecordInternal ID of Subsidiary.
titleString 

AddressBooks

Field NameData TypeDescription
addressbookAddressBookDetail[] 
replaceAllBooleanReplaces all Contact addresses when set to TRUE while updating the Contact

AddressBookDetail

Field NameData TypeDescription
addressbookAddressAddressDetailAddress Info
defaultBillingBooleanSets the address as a default billing one.
defaultShippingBooleanSets the address as a default shipping one.
internalIdString 
isResidentialBoolean 
labelString 

AddressDetail

Field NameData TypeDescription
addr1StringAddress Line 1
addr2StringAddress Line 2
addr3StringAddress Line 3
addrPhoneStringPhone Number
addresseeString 
attentionString 
cityString 
countryString 
internalIdStringInternal ID of existing Address
stateStringState/Province
zipString 

LookupRecord

Field NameData TypeDescription
externalIdStringRead-Only, returns the external Id of the Record selected.
internalId*StringInternal Id of the Record or List.
nameStringRead-Only, returns the name of the Record selected.
typeStringRead-Only.

CustomFields

Field NameData TypeDescription
customFieldCustomFieldInfo[]List of CustomField Info

CustomFieldInfo

Field NameData TypeDescription
fieldType*StringSpecifies the Data Type of a Custom field. Possible values are: string, boolean, date, double, long, select.
internalIdStringInternalId of the Custom Field.
scriptId*StringScript ID of the Custom Field.
valueStringRequired and returned for all the custom fields other than “select” (fieldType)
valueLookupLookupRecordRequired and returned for the fieldType “select”

Table of contents