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.
This article summarized available Partner Center Referrals APIs to create, update, and get partner referrals via REST API methods.
For detailed information regarding all Partner Center REST APIs, refer to Partner Center REST API reference.
REST APIs
| API | Description |
|---|---|
| Create Referral | Defines REST resource to create a new opportunity. |
| Update Referral | Defines REST resource to update an existing lead or opportunity. |
| Get Referrals | Defines REST resource to get leads and opportunities with available OData query operations. |
| Get Referral by ID | Defines REST resource to get a specified lead or opportunity by referral ID. |
About referrals
Based on source of creation and Partner-Customer engagement scenario, a referral can be classified as:
Further from referral's shareability perspective there are two types of ReferralType:
- Independent: Where a referral is visible to one partner.
- Shared: Where a referral is visible to two parties that are working together. For example, if Microsoft and a partner are working together in a Co-sell deal, a referral can be shared between both parties. For more information, see the section Creating a shared referral.
A Marketplace lead, Qualified lead, and a Co-sell Opportunity can be distinguished with combination of three parameters: ReferralType, Qualification, and InvitedBy.OrganizationID.
| Type | Qualification | InvitedBy.OrganizationID | Referral Category |
|---|---|---|---|
| Independent | Direct | msft or null | Marketplace Lead |
| Independent | SalesQualified or MarketingQualified | msft | Qualified Lead |
| Independent or Shared | SalesQualified or None | Partner's own Organization ID or inviting partner's Organization ID | Co-sell Opportunity |
Note
Only ReferralSource or CallToAction should not be treated as identification filters for Marketplace leads. For Profile leads, these parameters can be empty.
Note
MACC eligibility and customer matching features aren't available with the use of API integration.
Co-sell opportunity types
There are three types of co-sell opportunities that can be created from Partner Center - Private, Partner-Led, and Co-sell deals.
Typically, from the Partner Center user interface, the choices to select a deal type are presented to the user, but while creating a referral from the API, there are certain other steps to take. From the Partner Center referrals user interface, when you create a new deal, there's a Help needed from Microsoft section, where these choices are presented to the user.
- Private deal: You choose not to share the deal with Microsoft, select "No help needed," and answer "no" to the question, "Would you like to share the deal with Microsoft sellers?"
- Partner led: You choose "No help needed" but answer "yes" to the question, "Would you like to share the deal with Microsoft sellers?"
- Co-sell: You choose to get help from Microsoft and also answer "yes" to the question, "Would you like to share the deal with Microsoft sellers?"
Services Co-sell referral
To learn about Services Co-sell referral, refer to Services co-sell overview. To create a new Services Co-sell referral, refer to Create Services Co-sell opportunity.
Frequently asked questions (FAQs)
How to create test referrals? Is there a way to create a test account separately?
Answer: To create test or dummy referrals there's no separate environment exposed for partners. All referrals to be created via same Partner Center URL (api.partner.microsoft.com). To create referrals with no impact on production data, a partner can take following quick steps:
- Set up a separate Partner ID (Mpn ID) only for testing purpose.
- Create a new test account on Partner Center and assign Referrals Admin role to only that Partner ID.
- Use this account to create test referrals with small deal values, for example 2 USD, and deal name containing "Test" prefix.
- Additionally, partner can mark such deals as Closed-Error post testing is done.
How to create draft referrals before inviting Microsoft or any other partner?
Answer: A private referral is only visible to the partner creating it. For a Co-sell deal, the initially created referral is a private deal only until Microsoft referral is created in a subsequent API call.
How to create Private, Partner-Led or Co-sell referrals?
Answer: To learn how to create a Private, Partner-Led, or Co-sell referral, see here.
What are Solution Assessments deal types?
Answer: To learn about Solution Assessments deal types, see here
We have setup the App+User token account but getting error generating token.
Answer: Verify if necessary delegate API permissions are added and the admin consent is provided for the App ID created on Azure portal. To learn more, see here.