Skip to main content

StructuredLeadAttributes

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

StructuredLeadAttributesobjectStructuredLeadAttributes ↗
categoriesAllowCreatebooleanwrite only
categoriesarray · nullablewrite only
contactsarray · nullablewrite only
addressesarray · nullablewrite only
assetsarray · nullablewrite only
expensesarray · nullablewrite only
incomesarray · nullablewrite only
liabilitiesarray · nullablewrite only
employmentsarray · nullablewrite only
utmSourcestring · nullablewrite only
utmMediumstring · nullablewrite only
utmCampaignstring · nullablewrite only
utmTermstring · nullablewrite only
utmContentstring · nullablewrite only
sourceIdinteger · nullablewrite only

format: int32

sourceCategoryIdinteger · nullablewrite only

format: int32

sourceReferrerIdstring · nullablewrite only
sourceAdditionalDetailsstring · nullablewrite only

minLength: 0 · maxLength: 255

sourceSystemUrlstring · nullablewrite only
dealNamestring · nullablewrite only
noteTitlestring · nullablewrite only
noteDetailsstring · nullablewrite only
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