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:readA company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************
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"
A successful response
A prospective customer who has expressed interest in a company or product but has not yet purchased.
The unique identifier for the lead.
"lead_xxxxxxxxxxxxx"
The datetime the lead was created.
"2023-12-01T05:00:00.401Z"
The datetime the lead was last updated.
"2023-12-01T05:00:00.401Z"
The URL of the page that referred this lead to the company. Null if no referrer was captured.
"https://twitter.com/whabormarket"
Custom key-value pairs attached to this lead. Null if no metadata was provided.
The user account associated with this lead.
The product the lead expressed interest in. Null if the lead is not associated with a specific product.
The company member record if this lead has converted into a paying customer. Null if the lead has not converted.