Create lead
Record a new lead for a company, capturing a potential customer’s interest in a specific product.
Required permissions:
lead:managemember:email:readaccess_pass:basic:readmember:basic:read
Authorizations
An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.
Body
Parameters for CreateLeadV2
The unique identifier of the company to create the lead for, starting with 'biz_'.
"biz_xxxxxxxxxxxxxx"
A JSON object of custom metadata to attach to the lead for tracking purposes.
The unique identifier of the product the lead is interested in, starting with 'prod_'.
"prod_xxxxxxxxxxxxx"
The referral URL that brought the lead to the company, such as 'https://example.com/landing'.
The unique identifier of the user to record as the lead. If authenticated as a user, that user is used automatically.
"user_xxxxxxxxxxxxx"
Response
A successful response
A prospective customer who has expressed interest in a company or product but has not yet purchased.
The datetime the lead was created.
"2023-12-01T05:00:00.401Z"
The unique identifier for the lead.
"lead_xxxxxxxxxxxxx"
The company member record if this lead has converted into a paying customer. Null if the lead has not converted.
Custom key-value pairs attached to this lead. Null if no metadata was provided.
The product the lead expressed interest in. Null if the lead is not associated with a specific product.
The URL of the page that referred this lead to the company. Null if no referrer was captured.
"https://twitter.com/whabormarket"
The datetime the lead was last updated.
"2023-12-01T05:00:00.401Z"
The user account associated with this lead.

