Skip to main content

A prospective customer who has expressed interest in a company or product but has not yet purchased.

id
string
required

The unique identifier for the lead.

Example:

"lead_xxxxxxxxxxxxx"

created_at
string<date-time>
required

The datetime the lead was created.

Example:

"2023-12-01T05:00:00.401Z"

updated_at
string<date-time>
required

The datetime the lead was last updated.

Example:

"2023-12-01T05:00:00.401Z"

referrer
string | null
required

The URL of the page that referred this lead to the company. Null if no referrer was captured.

Example:

"https://twitter.com/whabormarket"

metadata
object
required

Custom key-value pairs attached to this lead. Null if no metadata was provided.

user
object
required

The user account associated with this lead.

product
object
required

The product the lead expressed interest in. Null if the lead is not associated with a specific product.

member
object
required

The company member record if this lead has converted into a paying customer. Null if the lead has not converted.