Input fields

accountNumber : String! required

The account number.
address : RichAddressInput

The billing 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 the opportunity is assigned to.
assignedToTeamIdentifier : String

The identifier of the team to assign the opportunity to.
assignedToTeamName : String

The name of the team the opportunity is assigned to.
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 to assign the opportunity to.
assignedToUsername : String

The username of the user to assign the opportunity to.
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 opportunity.
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 : [_CreateOpportunityExtraDetailsItem]

The extra details for the opportunity.
funnelCode : String! required

The code of the funnel.
leadContactDetails : LeadContactDetailsInput! required

The contact details for the lead.
leadType : String! required

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.
notes : String! required

Notes about the opportunity.
opportunityAddress : RichAddressInput

The address for the opportunity.
productOfferingId : String

The ID of the product offering.
salesChannel : String! required

The sales channel of the opportunity.
supplyPoints : [LeadSupplyPoint]

Supply points for the opportunity.
useSameAddressAsBilling : Boolean

Whether to use the same address for billing.
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-0C2753B1", "assignedToAffiliateNumber": "detail-TV-shake-population-happy", "assignedToTeamIdentifier": "78670059", "assignedToUserIdentifier": "37359509", "extraDetailsItems": _CreateOpportunityExtraDetailsItem, "funnelCode": "find-realize-support-he-red", "leadContactDetails": LeadContactDetailsInput, "leadType": "say-organization-task-to-whether", "notes": "number-computer-economy-design-now", "opportunityAddress": RichAddressInput, "productOfferingId": "16997202", "salesChannel": "manager-hour-PM-himself-suddenly", "supplyPoints": LeadSupplyPoint, "useSameAddressAsBilling": true }