The lead object
Required properties
Parameter | Type | Description |
---|---|---|
organization_id | String | The unique token provided to you by the organization. |
street1 | String | The number and street of the mailing address of the lead. |
state | String | The US state of the mailing address of the lead. The value should be abbreviated. Example: TX |
postal_code | String | The 5-digit postal code of the mailing address of the lead. Example: 76063 |
origin_member | Object | The quote origin member of the lead. Learn more about member types here. |
Optional properties
Parameter | Type | Description |
---|---|---|
city | String | The city of the mailing address of the lead. |
secondary_members | Array | An 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_quote | Object | The auto quote of the lead. Learn more about the auto quote object here. |
home_quotes | Array | An array of objects where each object represents a home quote of the lead. Learn more about the home quote object here. |
life_quotes | Array | An array of objects where each object represents a life quote of the lead. Learn more about the life quote object here. |
preferred_callback | String | The preferred callback time of the lead. The accepted (case sensitive) values are Anytime, Morning (8AM - 12PM), Afternoon (12PM - 5PM), and Evening (5PM - 9PM). |
notes | String | Notes about the lead. |
metadata | Object | The 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.