Input fields

accountNumber : String

Account number's external identifier.
address : RichAddressInput

The address for the lead.
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.
affiliateOrganisationId : Int

The ID of the affiliate organisation.
Deprecation
The 'affiliateOrganisationId' field is deprecated.

Please use 'assignedToAffiliateNumber' instead.

- Marked as deprecated on 2026-01-29.
- Scheduled for removal on or after 2026-03-27.
assignedToAffiliateNumber : String

The number of the affiliate organisation assigned to the lead.
Deprecation
The 'assignedToAffiliateNumber' field is deprecated.

Lead-level assignment is being removed. Assignment is managed at Opportunity level.

- Marked as deprecated on 2026-05-19.
- Scheduled for removal on or after 2026-07-19.
assignedToTeamIdentifier : String

The identifier of the team assigned to the lead.
Deprecation
The 'assignedToTeamIdentifier' field is deprecated.

Lead-level assignment is being removed. Assignment is managed at Opportunity level.

- Marked as deprecated on 2026-05-19.
- Scheduled for removal on or after 2026-07-19.
assignedToTeamName : String

The team associated with the lead.
Deprecation
The 'assignedToTeamName' field is deprecated.

Please use 'assignedToTeamIdentifier' instead.

- Marked as deprecated on 2026-04-22.
- Scheduled for removal on or after 2026-06-22.
assignedToUserIdentifier : String

The identifier of the user assigned to the lead.
Deprecation
The 'assignedToUserIdentifier' field is deprecated.

Lead-level assignment is being removed. Assignment is managed at Opportunity level.

- Marked as deprecated on 2026-05-19.
- Scheduled for removal on or after 2026-07-19.
assignedToUsername : String

The username of the user assigned to the lead.
Deprecation
The 'assignedToUsername' field is deprecated.

Please use 'assignedToUserIdentifier' instead.

- Marked as deprecated on 2026-04-22.
- Scheduled for removal on or after 2026-06-22.
consents : [ConsentTypeInput]

Consents to be associated with the lead.
Deprecation
The 'consents' field is deprecated.

Please use 'consents' on the lead contact instead of on the lead.

- Marked as deprecated on 2026-06-29.
- Scheduled for removal on or after 2026-09-29.
extraDetailsItems : [ExtraDetailsItem]

The extra details for the lead.
funnelCode : String

The code of the funnel.
Deprecation
The 'funnelCode' field is deprecated.

This field is not being used anymore for a Lead's creation.

- Marked as deprecated on 2025-03-20.
- Scheduled for removal on or after 2025-08-30.
leadContacts : [LeadContactDetailsInput]! required

A list of contact details for the lead.
leadType : LeadTypeChoices

The type of the lead.
nationalId : String

The national ID.
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.
salesChannel : String

The sales channel of the lead.
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.
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-8B9D680D", "extraDetailsItems": ExtraDetailsItem, "leadContacts": LeadContactDetailsInput, "leadType": "BUSINESS" }