The lead object

Required properties

ParameterTypeDescription
organization_idStringThe unique token provided to you by the organization.
street1StringThe number and street of the mailing address of the lead.
stateStringThe US state of the mailing address of the lead. The value should be abbreviated.
Example: TX
postal_codeStringThe 5-digit postal code of the mailing address of the lead.
Example: 76063
origin_memberObjectThe quote origin member of the lead. Learn more about member types here.

Optional properties

ParameterTypeDescription
cityStringThe city of the mailing address of the lead.
secondary_membersArrayAn array of objects where each object represents a member of the household that is not the origin member. Learn more about member types here.
auto_quoteObjectThe auto quote of the lead. Learn more about the auto quote object here.
home_quotesArrayAn array of objects where each object represents a home quote of the lead. Learn more about the home quote object here.
life_quotesArrayAn array of objects where each object represents a life quote of the lead. Learn more about the life quote object here.
preferred_callbackStringThe preferred callback time of the lead. The accepted (case sensitive) values are Anytime, Morning (8AM - 12PM), Afternoon (12PM - 5PM), and Evening (5PM - 9PM).
notesStringNotes about the lead.
metadataObjectThe metadata of the lead. It is not part of the response and is not shown to the user.

note

A lead is closely related to a member. It is recommended to check out member types and object.