Skip to main content

Fields

assignedToAffiliateNumber : String

The affiliate's name this opportunity is assigned to.

assignedToTeam : String

Team assigned to this opportunity.

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.
assignedToTeamIdentifier : String

The identifier of the team assigned to this opportunity.

assignedToUser : String

User assigned to this opportunity.

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.
assignedToUserIdentifier : String

The identifier of the user assigned to this opportunity.

attachments : [OpportunityAttachment]

Attachments for the opportunity.

conversionSalesChannel : String

Sales channel at conversion time.

creationSalesChannel : String

Sales channel recorded when the opportunity was first created.

email : String

Lead account holder email.

extraDetailItems : [ExtraDetail]

Extra details about the opportunity as key/value pairs.

extraDetails : JSONString

Extra details about the opportunity.

Deprecation
The 'extraDetails' field is deprecated.

Use `extraDetailsItems` instead, which provides a structured key/value format.

- Marked as deprecated on 2026-01-14.
- Scheduled for removal on or after 2026-07-14.
funnel : SalesFunnel

The sales funnel this opportunity is in.

leadNumber : String

Lead number.

leadType : String

Lead type.

name : String

Lead legal name.

notes : String

Notes for the opportunity.

number : String

Opportunity number.

offerGroupId : String

Offer group ID.

opportunityAddress : AddressOutput

Opportunity address.

opportunityId : ID

Opportunity ID.

Deprecation
The 'opportunityId' field is deprecated.

Use `number` instead.

- Marked as deprecated on 2025-12-16.
- Scheduled for removal on or after 2026-02-16.
opportunityRichAddress : RichAddressType

Opportunity rich address.

phoneNumber : String

Lead account holder phone number.

productOffering : OfferingType

The product offering of the opportunity.

productOfferingId : String

Product offering ID.

salesChannel : String

Sales channel.

stage : String

Current stage in a funnel.

supplyPoints : [LeadSupplyPointType]

List of supply points associated with the opportunity.

Arguments

Input fields for retrieving supply points by market.

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

{ "assignedToAffiliateNumber": "name-yes-model-bed-effort", "assignedToTeamIdentifier": "23562223", "assignedToUserIdentifier": "45906764", "attachments": [OpportunityAttachment], "conversionSalesChannel": "say-base-window-wide-pay", "creationSalesChannel": "whom-rather-bank-surface-drop", "email": "surface-vote-tough-however-travel", "extraDetailItems": [ExtraDetail], "funnel": SalesFunnel, "leadNumber": "just-performance-maintain-deep-issue", "leadType": "move-training-produce-everyone-her", "name": "nice-where-more-often-air", "notes": "win-drug-employee-common-chance", "number": "customer-find-serious-strategy-land", "offerGroupId": "32545835", "opportunityAddress": AddressOutput, "opportunityRichAddress": RichAddressType, "phoneNumber": "nation-make-talk-shoulder-now", "productOffering": OfferingType, "productOfferingId": "61439801", "salesChannel": "daughter-specific-tough-agency-notice", "stage": "actually-fast-purpose-right-power", "supplyPoints": [LeadSupplyPointType] }