| Field | Description |
|---|
| ContactID
|
Data Type: String
|
| Description: Unique identifier for the
contact record. If the optional value is not provided, a default GUID is created.
|
| FirstName
|
Data Type: String
|
| Description: First or chosen name. Default: " ".
|
| MiddleName
|
Data Type: String
|
| Description: Middle name. Default: " ".
|
| LastName
|
Data Type: String
|
| Description: Family or given name(s).
|
| Suffix
|
Data Type: Dropdown
|
| Description: Suffix appended to a name that may designate professional or legal status. Default: " ". Sample valid values: "AIA", "EIT", "III", "Jr.", "PE", "PE, RLS", "PhD", "PLS", "RLS", "Sr." from "CodeTable": "CFGSuffix".
|
| PreferredName
|
Data Type: String
|
| Description: Name the person prefers, usually a first name, which may differ from the full name provided. Default: " ".
|
| Title
|
Data Type: String
|
| Description: Professional title typically designated by the
organization to which a person belongs. Default: " ".
|
| Source
|
Data Type: String
|
| Description: Source referenced for the
contact. Default: " ". Sample valid values: "Brochure", "ClientRefe", "ColdCall", "Management", "Seminar/Co", Email", "Convention", "Walk-In" from "CodeTable": "CFGContactSource".
|
| ClientID
|
Data Type: String
|
| Description: Unique identifier for the
client record. Default : " ".
|
| ClientName
|
Data Type: String
|
| Description: Name of the
client's
firm. Default: " ". Obtain valid names from GET {{url}}/firm.
|
| Vendor
|
Data Type: Vendor
|
| Description: Alphanumeric short string identifier for the
consultant or partner name. Default: " ".
|
| Vname
|
Data Type: String
|
| Description:
Consultant or partner name. Default: " ".
|
| Email
|
Data Type: String
|
| Description: Email address. Default: " ".
|
| ContactStatus
|
Data Type: Dropdown
|
| Description: "A" = The
contact is currently active. "I" = The
contact is currently dormant or inactive. Default: "A". Valid values from "CodeTable": "ContactStatus".
|
| CustomCurrencyCode
|
Data Type: String
|
| Description: User defined currency code. Default: " ". Valid values from "CodeTable": "FW_CFGCurrency".
|
| Address1
|
Data Type: String
|
| Description: Line 1 of the address. Default: " ".
|
| Address2
|
Data Type: String
|
| Description: Line 2 of the address. Default: " ".
|
| Address3
|
Data Type: String
|
| Description: Line 3 of the address. Default: " ".
|
| Address4
|
Data Type: String
|
| Description: Line 4 of the address. Default: " ".
|
| City
|
Data Type: String
|
| Description: Name of the City. Default: " ".
|
| State
|
Data Type: String
|
| Description: Name of the state or province. Default: " ".
|
| Zip
|
Data Type: String
|
| Description: Postal zip code. Default: " ".
|
| Country
|
Data Type: String
|
| Description: Name of the country. Default: " ".
|
| Phone
|
Data Type: String
|
| Description: Phone number. Default: " ".
|
| Fax
|
Data Type: String
|
| Description: Fax number. Default: " ".
|
| CellPhone
|
Data Type: String
|
| Description: Mobile or cellular telephone number. Default: " ".
|
| HomePhone
|
Data Type: String
|
| Description: Home telephone number. Default: " ".
|
| Pager
|
Data Type: String
|
| Description: Telephone number to send a page. Default: " ".
|
| MailingAddress
|
Data Type: String
|
| Description: "Y" designates that this is the physical mailing address which may differ or be the same as the physical office or residential location. "N" designates that this address is not the mailing address. Default: "Y".
|
| FirmAddress1
|
Data Type: String
|
| Description: Line 1 of the
firm's address. Default: " ".
|
| FirmAddress2
|
Data Type: String
|
| Description: Line 2 of the
firm's address. Default: " ".
|
| FirmAddress3
|
Data Type: String
|
| Description: Line 3 of the
firm's address. Default: " ".
|
| FirmAddress4
|
Data Type: String
|
| Description: Line 4 of the
firm's address. Default: " ".
|
| FirmCity
|
Data Type: String
|
| Description: Name of the city where the
firm is located / where the
firm conducts business. Default: " ".
|
| FirmState
|
Data Type: String
|
| Description: Name of the state or providence where the
firm is located / where the
firm conducts business. Default: " ".
|
| FirmZip
|
Data Type: String
|
| Description: Postal zip code of the
firm. Default: " ".
|
| FirmCountry
|
Data Type: String
|
| Description: Name of the country where the
firm is located / where the
firm conducts business. Default: " ".
|
| FirmBusinessPhone
|
Data Type: String
|
| Description: Business telephone number for the
firm. Default: " ".
|
| FirmBusinessPhoneFormat
|
Data Type: String
|
| Description: Format of the
firm's business telephone number set by admin under
. The API does not support or enforce format validation. When creating or updating an object, be sure to pass in the phone number string in the format the
organization wants to match across
DPS. Formatting only happens client side when set in the UI. Setting this field will return an empty string. Default: " ". Example: "(###)###-###" or "###.###.####".
|
| FirmBusinessFax
|
Data Type: String
|
| Description: Fax telephone number for the
firm. Default: " ".
|
| FirmBusinessFaxFormat
|
Data Type: String
|
| Description: Format of the
firm's fax telephone number set by admin under
. The API does not support or enforce format validation. When creating or updating an object, be sure to pass in the phone number string in the format the
organization wants to match across
DPS. Formatting only happens client side when set in the UI. Setting this field will return an empty string. Default: " ". Example: "(###)###-###" or "###.###.####".
|
| FirmPager
|
Data Type: String
|
| Description:
Firm's pager phone number. Default: " ".
|
| FirmDescription
|
Data Type: String
|
| Description: Text description of the
firm such as its history and purpose. Default: " ".
|
| Memo
|
Data Type: String
|
| Description: Notes about the attribute or element. Default: " ".
|
| Billing
|
Data Type: String
|
| Description: "Y" Yes, this object is included with the billing application. "N" No, the object is not included with the billing application. Default: "N".
|
| PrimaryInd
|
Data Type: String
|
| Description: "Y" Yes, this object is primary. "N" No, this object is not primary. Default: "N".
|
| Addressee
|
Data Type: String
|
| Description: Sender's address. Default: " ".
|
| CLAddress
|
Data Type: String
|
| Description:
Client address. Default: " ".
|
| VEAddress
|
Data Type: String
|
| Description:
Vendor address. Default: " ".
|
| CreateUser
|
Data Type: String
|
| Description: Name of the person who created the new record. Default: " ".
|
| CreateDate
|
Data Type: Datetime
|
| Description: Date and timestamp when the new record was created. Default: " ".
|
| ModUser
|
Data Type: String
|
| Description: Name of the person who modified an existing record. Default: " ".
|
| ModDate
|
Data Type: Date
|
| Description: Date and timestamp when the existing record was modified. Default: " ".
|
| CellPhoneFormat
|
Data Type: String
|
| Description: Format of the cellular or mobile telephone number set by admin under
. The API does not support or enforce format validation. When creating or updating an object, be sure to pass in the phone number string in the format the
organization wants to match across
DPS. Formatting only happens client side when set in the UI. Setting this field will return an empty string. Default: " ". Example: "(###) ###-###" or "###.###.####".
|
| HomePhoneFormat
|
Data Type: String
|
| Description: Format of the home telephone number set by admin under
. The API does not support or enforce format validation. When creating or updating an object, be sure to pass in the phone number string in the format the
organization wants to match across
DPS. Formatting only happens client side when set in the UI. Setting this field will return an empty string. Default: " ". Example: "(###) ###-###" or "###.###.####".
|
| PagerFormat
|
Data Type: String
|
| Description: Format of the pager telephone number set by admin under
. The API does not support or enforce format validation. When creating or updating an object, be sure to pass in the phone number string in the format the
organization wants to match across
DPS. Formatting only happens client side when set in the UI. Setting this field will return an empty string. Default: " ". Example: "(###) ###-###" or "###.###.####".
|
| Company
|
Data Type: String
|
| Description: Company Name. Default: " ".
|
| flName
|
Data Type: String
|
| Description: Full name with suffix only. Default: " ".
|
| emOwnerfl
|
Data Type: String
|
| Description: Full name of the
employee designated as the owner. Default: " ".
|
| RecentOpportunityName
|
Data Type: String
|
| Description: Name of the most recent
opportunity. Default: " ".
|
| RecentOpportunityID
|
Data Type: String
|
| Description: Unique identifier for the recent
opportunity. Default: " ".
|
| RecentOppRole
|
Data Type: String
|
| Description: Name of the role for the recent
opportunity. Default: " ".
|
| TopTPSubject
|
Data Type: String
|
| Description: Activity name that displays as the last activity subject from for the most recent touchpoint. Default: " ".
|
| TopTPContactID
|
Data Type: String
|
| Description: Unique identifier for the
contact associated with the most recent touchpoint. Default: " ".
|
| TopTPCreateEmployee
|
Data Type: String
|
| Description:
Employee identifier for the most recent touchpoint. Default: " ".
|
| TopTPCreateUserName
|
Data Type: String
|
| Description: Username of the user who created the most recent touchpoint. Default: " ".
|
| HasPhoto
|
Data Type: Numeric
|
| Description: 0 - The object does not have a photo. 1 - The object does have a photo. Default: " ".
|
| PhotoModDate
|
Data Type: String
|
| Description: Date and timestamp of when the photo was updated. Default: " ".
|
| TLInternalKey
|
Data Type: String
|
| Description: TrafficLIVE internal key. Default: " ".
|
| TLSyncModDate
|
Data Type: Date
|
| Description: Date and timestamp when TrafficLIVE synchronization occurred. Default: " ".
|
| Rating
|
Data Type: String
|
| Description: Score indicating the conversion strength of lead. CRM Plus module only and lead qualification process must both be enabled. Default: " ".
|
| Market
|
Data Type: String
|
| Description: Code that identifies the market segment or channel. Default: " ".
|
| Website
|
Data Type: String
|
| Description: Publicly available website address. Default: " ".
|
| QualifiedStatus
|
Data Type: Dropdown
|
| Description: Object's qualification status. CRM Plus module only and lead qualification process must both be enabled. GET
contact metadata for codes. Valid values: "sysNew", "sysQual", "sysDisqual". Default: "sysQual".
|
| StatusReason
|
Data Type: String
|
| Description: Reason why the qualification status was set to new, qualified, or disqualified. CRM Plus module only and lead qualification process must both be enabled. Default: " ".
|
| StatusDate
|
Data Type: Datetime
|
| Description: When the status was set or changed. Minimum format accepted "YYYY-MM-DD". Default: "[TODAY]".
|
| ProfessionalSuffix
|
Data Type: String
|
| Description: Professional credential appended to a name usually as an acronym. Default: " ".
|
| SFID
|
Data Type: String
|
| Description: Globally unique Salesforce identification value. Default: " ".
|
| SFLastModifiedDate
|
Data Type: Datetime
|
| Description: Date and the time Salesforce was last changed. Default: " ".
|
| AjeraSync
|
Data Type: String
|
| Description: "Y" indicates the Ajera module is active. "N" indicates the Ajera module is not active. Default: "N".
|
