LeadOutput
Fields
Lead's linked account number.
Team assigned to this lead.
Deprecation
The 'assignedToTeam' field is deprecated.Please use 'assignedToTeamIdentifier' instead.
- Marked as deprecated on 2026-04-22.
- Scheduled for removal on or after 2026-06-22.
User assigned to this lead.
Deprecation
The 'assignedToUser' field is deprecated.Please use 'assignedToUserIdentifier' instead.
- Marked as deprecated on 2026-04-22.
- Scheduled for removal on or after 2026-06-22.
Lead billing address.
Deprecation
The 'billingAddress' field is deprecated.Please use 'contactAddress' on the lead contact with the ACCOUNT_HOLDER role instead.
- Marked as deprecated on 2026-06-18.
- Scheduled for removal on or after 2026-09-18.
Lead billing name.
Deprecation
The 'billingName' field is deprecated.Please use 'givenName' and 'familyName' on the lead contact with the ACCOUNT_HOLDER role instead.
- Marked as deprecated on 2026-06-18.
- Scheduled for removal on or after 2026-09-18.
Lead billing rich address.
Deprecation
The 'billingRichAddress' field is deprecated.Please use 'contactAddress' on the lead contact with the ACCOUNT_HOLDER role instead.
- Marked as deprecated on 2026-06-18.
- Scheduled for removal on or after 2026-09-18.
Lead brand.
The contacts for the lead.
Arguments
Input fields for filtering contacts.
Lead account holder email.
Extra details about the lead as key/value pairs.
Lead legal family name.
The lead funnel this lead is in.
Lead legal given name.
Lead ID.
The type of the lead.
National Identifier of the lead.
Deprecation
The 'nationalId' field is deprecated.Please use 'leadContact.nationalId' instead.
- Marked as deprecated on 2026-06-10.
- Scheduled for removal on or after 2026-09-10.
Lead number.
Lead account holder mobile number.
Lead sales channel.
Deprecation
The 'salesChannel' field is deprecated.Sales channel information is being removed from the Lead model. This is information is saved in the Opportunity.
- Marked as deprecated on 2025-06-17.
- Scheduled for removal on or after 2025-10-17.
Current stage in a funnel.
The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.
Example
{
"accountNumber": "A-A2C66EC4",
"brand": "ago-reach-sport-billion-hope",
"contacts": [LeadContactDetailsType],
"email": "money-statement-part-energy-job",
"extraDetailItems": [ExtraDetail],
"familyName": "Mccormick",
"funnel": SalesFunnel,
"givenName": "Stephen",
"leadId": "15865251",
"leadType": "need-record-stand-inside-friend",
"number": "travel-trial-husband-throw-tree",
"phoneNumber": "especially-take-actually-land-apply",
"stage": "note-some-reason-necessary-allow"
}