Skip to main content

LeadAttributes

Expand fields to inspect their types, constraints and related schemas. Requiredness is defined at each object level.

LeadAttributesobjectLeadAttributes ↗
categoriesAllowCreatebooleanwrite only
categoriesarray · nullablewrite only
dateOfBirthstring · nullablewrite only

format: date

titlestring · nullablewrite only

Allowed values: "Mr" "Mrs" "Ms" "Miss" "Master" "Dr" null

firstNamestring · nullablewrite only
preferredNamestring · nullablewrite only
lastNamestring · nullablewrite only
emailstring · nullablewrite only
mobilestring · nullablewrite only
contactMatchExistingstring · nullablewrite only

Allowed values: "Email" "EmailMobile" "EmailName" "EmailMobileName" "EmailDateOfBirth" "EmailDateOfBirthName" null

genderstring · nullablewrite only

Allowed values: "Male" "Female" "Undisclosed" null

maritalStatusstring · nullablewrite only

Allowed values: "Single" "Married" "DeFacto" "Separated" "Divorced" "Widowed" null

hasMarketingConsentboolean · nullablewrite only
isGuarantorboolean · nullablewrite only
isDependantboolean · nullablewrite only
isPrimaryboolean · nullablewrite only
streetAddressstring · nullablewrite only
suburbstring · nullablewrite only
statestring · nullablewrite only
postCodestring · nullablewrite only
countrystring · nullablewrite only
addressTypestring · nullablewrite only

Allowed values: "Current" "Postal" "PostSettlement" "Previous" "Other" null

formattedAddressstring · nullablewrite only

minLength: 0 · maxLength: 500

dealNamestring · nullablewrite only
noteTitlestring · nullablewrite only
noteDetailsstring · nullablewrite only
utmSourcestring · nullablewrite only
utmMediumstring · nullablewrite only
utmCampaignstring · nullablewrite only
utmTermstring · nullablewrite only
utmContentstring · nullablewrite only
sourceSystemUrlstring · nullablewrite only
sourceIdinteger · nullablewrite only

format: int32

sourceCategoryIdinteger · nullablewrite only

format: int32

sourceReferrerIdstring · nullablewrite only
sourceAdditionalDetailsstring · nullablewrite only

minLength: 0 · maxLength: 255

externalReferencestring · nullablewrite only

minLength: 0 · maxLength: 255

externalIntegrationstring · nullablewrite only

minLength: 0 · maxLength: 100

externalIntegrationAllowCreatebooleanwrite only
sendNotificationbooleanwrite only
customStatusNamestring · nullableread only
dealStatusstring · nullableread only

Allowed values: "NewLeads" "Researching" "PreApproved" "ConditionallyApproved" "UnconditionallyApproved" "Lodged" "InProgress" "PendingSettlement" "Varied" "Repaid" "Withdrawn" "Cancelled" "Settled" null