Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

FieldDescriptionFormatRequiredField TypeNotes
displayNameThe participants name formatted as defined by the Display Name Format global preference.stringtruedefault 
isCompanyDefines the participant as either a Company or Individual.booleantruedefault 
companyNameThe name of the company if the participant is a Company, or the name of the employer if the participant is an Individual.stringfalsedefault 
salutationThe Individual's prefix.stringfalsedefault 
firstNameThe Individual's first name.stringfalsedefault 
middleNameThe Individual's middle name.stringfalsedefault 
lastNameThe Individual's last name.stringfalsedefault 
suffixThe Individual's suffix.stringfalsedefault 
preferredNameThe Individual's preferred name.stringfalseadditional 
physicalAddressLine1The primary field for the physical address of the participant.stringfalsedefault 
physicalAddressLine2An optional secondary address field for the physical address.stringfalsedefault 
physicalCityThe city portion of the physical address.stringfalsedefault 
physicalStateProvinceThe state or province portion of the physical address.stringfalsedefault 
physicalPostCodeThe postcode or zip code portion of the physical address.stringfalsedefault 
physicalCountryThe associated countries resource for the country portion of the physical address.stringfalselink 
mailingAddressLine1The primary field for the mailing address of the participant.stringfalseadditional 
mailingAddressLine2An optional secondary address field for the mailing address.stringfalseadditional 
mailingCityThe city portion of the mailing address.stringfalseadditional 
mailingStateProvinceThe state or province portion of the mailing address.stringfalseadditional 
mailingPostCodeThe postcode or zip code portion of the mailing address.stringfalseadditional 
mailingCountryThe associated countries resource for the country portion of the mailing address.stringfalselink 
phone1Label A description of the primary phone number.stringfalsedefault 
phone1Country The country portion of the primary phone number.stringfalsedefault 
phone1Area The area code portion of the primary phone number.stringfalsedefault 
phone1Number The number portion of the primary phone number.stringfalsedefault 
phone1Notes A notes field for the primary phone number.stringfalsedefault 
phone2Label A description of the secondary phone number.stringfalseadditional 
phone2Country The country portion of the secondary phone number.stringfalseadditional 
phone2Area The area code portion of the secondary phone number.stringfalseadditional 
phone2Number The number portion of the secondary phone number.stringfalseadditional 
phone2Notes A notes field for the secondary phone number.stringfalseadditional 
phone3Label A description of the tertiary phone number.stringfalseadditional 
phone3Country The country portion of the tertiary phone number.stringfalseadditional 
phone3Area The area code portion of the tertiary phone number.stringfalseadditional 
phone3Number The number portion of the tertiary phone number.stringfalseadditional 
phone3Notes A notes field for the tertiary phone number.stringfalseadditional 
phone4Label A description of the quaternary phone number.stringfalseadditional 
phone4Country The country portion of the quaternary phone number.stringfalseadditional 
phone4Area The area code portion of the quaternary phone number.stringfalseadditional 
phone4Number The number portion of the quaternary phone number.stringfalseadditional 
phone4Notes A notes field for the quaternary phone number.stringfalseadditional 
fax The participant's fax number.stringfalseadditional 
sms The number to use for SMS.stringfalseadditional 
email The participant's email address.stringfalsedefault 
website The participant's web address.stringfalseadditional 
occupation The participant's occupation.stringfalseadditional 
taxNumber The tax number.stringfalseadditional Uses the Tax Number Alias on the Base Participant Type.
birthTimestamp The participant's Date of Birth.timestampfalsedefault 
deathTimestamp The participant's Date of Death.timestampfalseadditional 
maritalStatus Marital status.stringfalsedefault 
gender Gender.stringtruedefault 
emailFormat The preferred email format for the participant.stringfalseadditional Text / HTML
notificationMethod The preferred notification method for the participant.stringfalseadditional 
isNewsletterSubscriber If the participant is a Newsletter subscriber.booleanfalseadditional Deprecated?
modifiedTimestamp Timestamp when the record was last modified.timestampfalseadditional 
createdTimestamp Timestamp when the record was created.timestampfalseadditional 
division The associated divisions resource for the participant.stringtruelink 
billingPreference The associated billingpreference resource of the participant.stringfalselink 

 

Link Templates

...