Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Applies to:
- Partner Center
These resources represent a sales lead direct from a customer, Microsoft, or another partner.
Note
The Solution Areas and Solution Plays taxonomy is updated for FY26. As a Partner Center Referrals API consumer, ensure that you're passing the updated Solution Areas and Solution Plays when creating referrals.
Referral
Represents the referral.
| Property | Type | Description |
|---|---|---|
| ID | string | The ID for this Referral. |
| EngagementID | string | The EngagementID for this Referral. Multiple referrals can be associated to a single EngagementID |
| Name | string | The name of the Referral. |
| ExternalReferenceID | string | An external identifier for the referral. Example: Store your own Dynamics 365 lead/opportunity ID |
| CreatedDateTime | string in UTC date time format | The date the referral was created. |
| UpdatedDateTime | string in UTC date time format | The date the referral was last updated. |
| ExpirationDateTime | string in UTC date time format | The date the referral expires. |
| AcceptedDateTime | string in UTC date time format | The date partner accepted the referral. For outgoing referrals, it's same date as referral creation datetime. |
| Status | ReferralStatus | An Enum with values that indicate the referral status. |
| Substatus | ReferralSubstatus | An Enum with values that indicate the referral sub status. |
| StatusReason | string | A descriptive message about the status. Example: Why was the referral lost? |
| Type | ReferralType | Represents the referral type. |
| Qualification | ReferralQualification | Represents the quality of the referral. |
| ReferralSource | ReferralSource | Represents source of Marketplace lead |
| CallToAction | CallToAction | Represents call to action for a Marketplace lead |
| CustomerProfile | CustomerProfile | Information about the customer. |
| Consent | Consent | Consent flags around sharing information with other organizations and allowing them to contact users. |
| Details | ReferralDetails | Customer details, notes, deal value, currency closing date. |
| Team | Member | Represents users in the organizations that are involved. |
| InviteContext | InviteContext | Represents more information a user can provide when inviting another organization into the partner engagement. |
| ETag | string | ETags are used and required for concurrency checking when updating resources. |
| Target | ReferralTarget | Represents more information a user can provide when inviting another organization into the partner engagement. |
| MpnId | numeric string | Represent a Partner ID that identifies the partner. |
ReferralStatus
An Enum with values that indicate the referral status.
| Value | Description |
|---|---|
| None | |
| New | Represents a new referral. |
| Active | Represents an active referral. |
| Closed | Represents a closed referral. |
ReferralSubstatus
An Enum with values that indicate the referral status.
| Value | Description |
|---|---|
| None | |
| Pending | Represents a new referral that is pending. |
| Received | Represents a new referral that was received. |
| Accepted | Represents an active referral that was accepted. |
| Won | Represents a closed referral that was won. |
| Lost | Represents a closed referral that was lost. |
| Declined | Represents a closed referral that was declined. |
| Expired | Represents a closed referral that was expired. |
| Error | Represents a closed referral marked as error. |
Status transition & Substatus states
| Status | Allowed Status Transition | Allowed Substatus |
|---|---|---|
| New | New, Active, Closed | Pending, Received |
| Active | Active, Closed | Accepted |
| Closed | Closed | Won, Lost, Declined, Expired, Error |
ReferralType
An Enum with values that indicate the referral type.
| Property | Description |
|---|---|
| Shared | Represents a referral in which all parties involved collaborate to close. |
| Independent | Represents a referral in which two parties collaborate to close. |
ReferralQualification
An Enum with values that indicate the referral status.
| Value | Description |
|---|---|
| None | Represents a referral that has no quality measure associated. |
| Direct | Represents a referral that a customer created directly. |
| MarketingQualified | Represents a referral that was generated via Microsoft marketing automation systems. |
| SalesQualified | Represents a referral from a Microsoft sales agent. |
Referralsource
An Enum with values that indicate source of the Marketplace lead.
| Value |
|---|
| AppSource |
| AzureMarketplace |
| AzurePortal |
| PowerBI |
CallToAction
An Enum with values that indicate call to action for the Marketplace lead.
| Value |
|---|
| ContactMe |
| FreeTrial |
| GetItNow |
CustomerProfile
Contains the customer contact information.
| Property | Type | Description |
|---|---|---|
| Name | string | The customer organization name. |
| Address | Address | The address of the customer. |
| Size | string | The number of employees at the customer's organization. |
| Team | Member | The contacts for the customer's organization. |
| IDs | CustomerProfileType | An Array of values that indicate External IDs for the customer. |
CustomerProfileType
Contains the External IDs for the customer.
| Property | Type | Description |
|---|---|---|
| Moodys | string | The Moody's ID for the customer. |
| External | string | A customer ID unique to your organization. |
| Duns | string | [Obsolete] The Dun & Bradstreet number for the customer. |
Address
An address to use for the customer.
| Property | Type | Description |
|---|---|---|
| AddressLine1 | string | The first line of the address. |
| AddressLine2 | string | The second line of the address. This property is optional. |
| City | string | The city. |
| State | string | The state. |
| PostalCode | string | The zip code or postal code |
| Country | string | The country/region in ISO 3166 2-letter country code format. |
| Region | string | The region. |
Member
Describes contact information for a specific individual.
| Property | Type | Description |
|---|---|---|
| FirstName | string | The contact's first name. |
| LastName | string | The contact's surname. |
| PhoneNumber | string | The contact's phone number. |
| string | The contact's email address. | |
| ContactPreference | ContactPreference | The contact's preference for receiving email notifications. |
ContactPreference
Describes contact preferences for receiving email notifications.
| Property | Type | Description |
|---|---|---|
| Locale | string | The locale of the email notification. AllCultures, NeutralCultures, and SpecificCultures are supported |
| DisableNotifications | bool | Disables email notifications for the user. |
Consent
Consent flags around sharing information with other organizations and allowing them to contact users.
| Property | Type | Description |
|---|---|---|
| ConsentToToShareInfoWithOthers | boolean | Indicates consent to share personal data with others. |
| ConsentToContact | boolean | Indicates consent to contact users. |
| ConsentToShareReferralWithMicrosoftSellers | boolean | Indicates consent to share the deal with Microsoft sellers. |
| ConsentToMicrosoftToContactSpecificPartners | boolean | Indicates consent to let Microsoft contact specific partners for this deal. |
InviteContext
More information that can be shared when inviting another organization.
| Property | Type | Description |
|---|---|---|
| Notes | string | More notes for the receiving organization. |
| InvitedBy | InvitedBy | The organization ID that sent the referral. |
InvitedBy
More information that can be shared when inviting another organization.
| Property | Type | Description |
|---|---|---|
| OrganizationID | string | The organization ID that sent the referral. |
| OrganizationName | string | The organization name that sent the referral. |
ReferralDetails
Represents the referral details.
| Property | Type | Description |
|---|---|---|
| Notes | string | More notes for the receiving organization. |
| DealValue | decimal | Value of the referral. |
| Currency | string | The ISO 4217 currency symbol |
| ClosingDateTime | string in UTC date time format | Date the customer is looking to close by. |
| Requirements | ReferralRequirements | Industry, products, service type, and solutions the customer is interested in. |
ReferralRequirements
Contains the customer requirements.
| Property | Type | Description |
|---|---|---|
| Industries | Tag | The industries the customer is interested in. |
| Products | Tag | The products the customer is interested in. |
| Services | Tag | The services the customer is interested in. |
| Solutions | SolutionTag | The solutions the customer is interested in. |
| Offers | OfferTag | The offers the customer is interested in. |
| AdditionalRequirements | AdditionalRequirements | Other attributes in referral requirements. |
SolutionTag
Contains the solution details.
| Property | Type | Description |
|---|---|---|
| ID | string | The ID of the solution. |
| Name | string | The name of the solution. |
| Type | SolutionType | The type of solution. |
| SolutionType | string | Possible types are 1P, 3P, and SA. |
| Price | string | The price of the solution. |
| Currency | string | The currency of the solution. The ISO 4217 currency symbol. |
| Quantity | number | The quantity of the solution. |
| PublisherName | string | The solution publisher's organization name. |
SolutionType
An Enum with values that indicate the solution type.
| Property | Description |
|---|---|
| None | |
| Category | Uses predefined solution names. |
| Name | Ability to reference solutions from the Microsoft catalog. |
OfferTag
Contains the offer details.
| Property | Type | Description |
|---|---|---|
| ID | string | The ID of the offer. |
| Name | string | The name of the offer. |
| Type | SolutionType | The type of offer. |
| OfferType | string | Possible types are 1P, 3P, and SA. |
| PublisherName | string | The offer publisher's organization name. |
AdditionalRequirements
Contains other attributes in referral requirements.
| Property | Type | Description |
|---|---|---|
| Iot | IoTRequirements | Describes IoT requirements for an IoT deal. |
| Attributes | AttributeTag | List of other attributes in the referral. |
IoTRequirements
Describes the OEM IoT requirements.
| Property | Type | Description |
|---|---|---|
| CustomerLicenseAgreementNumber | string | Customer license agreement between partner and customer for OEM IoT deals. |
| DeviceCategory | string | The device category for the OEM IoT devices. |
| SiliconType | string | The CPU type for the OEM IoT devices. |
| AzureCertifiedDevice | boolean | Indicates if the device is Azure Certified and works well with Azure. |
| AttachServices | boolean | Indicates if partners are adding any add-on service apart from the solution in the deal. |
AttributeTag
Describes the attribute tag.
| Property | Type | Description |
|---|---|---|
| ID | string | Indicates the associated value of the attribute. |
| Type | string | Indicates attribute property type, for example, CustomerMarketplaceIntent |
CustomerMarketplaceIntent
An Enum with values that indicate the customer's purchase intent on Microsoft marketplace.
Note
In API requests, CustomerMarketplaceIntent is set into AdditionalRequirements as attribute, where Type: "CustomerMarketplaceIntent", and ID as the enum value.
| Property | Description |
|---|---|
| Yes | Customer has intent to transact on Microsoft marketplace. |
| No | Customer has no intent to transact on Microsoft marketplace. |
| HaveNotDecided | Customer yet to decide on intent to transact on Microsoft marketplace. |
Target
Describes the Referral Target.
| Property | Type | Description |
|---|---|---|
| ID | string | The ID of the referral target. |
| Type | ReferralTargetType | Referral target type |
TargetType
An Enum with values that indicate the solution type.
| Property | Description |
|---|---|
| None | |
| BusinessProfileLocation | Profile location from the partner business profile. |
| SolutionProfile | Solution profile of the partner. |
Tag
Describes the tag.
| Property | Type | Description |
|---|---|---|
| ID | string | The ID for this tag. |
Products
| Value |
|---|
| Azure |
| EnterpriseMobilityAndSecurity |
| Exchange |
| DeveloperTools |
| Dynamics365Business |
| Dynamics365Enterprise |
| DynamicsAX,GP,NAV,SL |
| Microsoft365 |
| Office |
| PowerBI |
| Project |
| SharePoint |
| SkypeForBusiness |
| Surface |
| SurfaceHub |
| SQL |
| Teams |
| Visio |
| Windows |
| Yammer |
Services
| Value |
|---|
| ConsultingAndProfessional |
| CustomSolution(ISV) |
| DeploymentOrMigration |
| Hardware |
| Integration |
| IPServices(ISV) |
| LearningAndCertification |
| Licensing |
| ManagedServices |
| ProjectServices |
Industries
| Value |
|---|
| Agriculture, Forestry, & Fishing |
| Communications & Media |
| Education |
| Financial Services |
| Government |
| Healthcare |
| Hospitality |
| Manufacturing |
| Power & Utilities |
| Public Safety and National Security |
| Retail & Consumer Goods |
| Services |
| Travel & Transportation |
| Wholesale & Distribution |
Solutions
| Value |
|---|
| AdvancedAnalytics |
| ApplicationIntegration |
| ArtificialIntelligence |
| AzureSecurityOperationManagement |
| AzureStack |
| BackupDisasterRecovery |
| BigData |
| Blockchain |
| Chatbot |
| CloudDatabaseMigration |
| CloudMigration |
| CloudVoice |
| CognitiveServices |
| CompetitiveDatabaseMigration |
| Containers |
| DataWarehouse |
| DatabaseonLinux |
| DevelopmentandTest |
| DevOps |
| DigitalMedia |
| Dynamics365forCustomerService |
| Dynamics365forFieldService |
| Dynamics365forFinanceOperations |
| Dynamics365forRetail |
| Dynamics365forSales |
| Dynamics365forTalent |
| DynamicsonAzure |
| EnterpriseBusinessIntelligence |
| Gaming |
| HighPerformanceComputing |
| HybridStorage |
| IdentityandAccessManagement |
| InformationManagement |
| InternetofThings |
| MachineLearning |
| Microserviceapplications |
| MobileApplications |
| MySQLPostgresMigrationtoAzure |
| Networking |
| NoSQLMigration |
| RedhatonAzure |
| RegulatoryComplianceGDPR |
| SAPonAzure |
| ServerlessComputing |
| SharepointonAzure |
| SQLServerUpgrade |
| ThreatProtection |
| WebDevelopment |
Customer Size
| Value |
|---|
| 1to50employees |
| 51to500employees |
| Morethan500employees |
| 1to9employees |
| 10to50employees |
| 51to250employees |
| 251to1000employees |
| 1001to5000employees |
| 5001to10000employees |
| 10001to20000employees |
| Morethan20000employees |
PartnerRole
| Value |
|---|
| Adoption and change management |
| Business strategy |
| Deployment services |
| Managed services |
| Presales envisioning |
| Proof of concept |
| Solution design |
| Transaction |
SolutionArea
The following table shows the values for Solution Area and Solution Play fields for FY26.
| Solution Area | Solution Play |
|---|---|
| AI Business Solutions | Converged Communications |
| AI Business Solutions | Data Security |
| AI Business Solutions | Sales Transformation with AI |
| AI Business Solutions | Copilot and Agents at Work |
| AI Business Solutions | Secure AI Productivity |
| AI Business Solutions | Scale with Cloud and AI Endpoints |
| AI Business Solutions | Innovate with Low Code AI and Agents |
| AI Business Solutions | ERP Transformation with AI |
| AI Business Solutions | Service Transformation with AI |
| AI Business Solutions | AI Ready with Surface Copilot PCs |
| AI Business Solutions | Scale Business Operations with AI |
| AI Business Solutions | Drive Cloud Success through Unified with Enhanced Solution |
| Cloud and AI Platforms | Innovate with Azure AI Apps and Agents |
| Cloud and AI Platforms | Unify Your Data Platform |
| Cloud and AI Platforms | Migrate and Modernize Your Estate |
| Cloud and AI Platforms | Modern SecOps with Unified Platform |
| Cloud and AI Platforms | Protect Cloud AI Platform and Apps |
| Cloud and AI Platforms | Copilot and Agents at Work |
| Cloud and AI Platforms | Scale with Cloud and AI Endpoints |
| Cloud and AI Platforms | Innovate with Low Code AI and Agents |
| Cloud and AI Platforms | Drive Cloud Success through Unified with Enhanced Solutions |
| Microsoft Unified | Drive Cloud Success through Unified with Enhanced Solutions |
| Security | Protect Cloud AI Platform and Apps |
| Security | Data Security |
| Security | Modern SecOps with Unified Platform |
| Security | Migrate and Modernize Your Estate |
| Security | Secure AI Productivity |
| Security | Unify Your Data Platform |
| Security | Converged Communications |
| Security | Drive Cloud Success through Unified with Enhanced Solutions |
| Security | Copilot and Agents at Work |