Partner Center Referrals

Status: Preview

Tier: Premium

Version: 1.0

Name

Summary

GetAllReferrals ([advanced][Optional]string $expand, [advanced][Optional]string $filter, [advanced][Optional]string $select, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip, [advanced][Optional]boolean $count, [internal]string content-type, [Optional]string MS-CorrelationId, [internal][Optional]string X-Caller-Id)

Get all referrals

CreateReferral (Microsoft.Partner.Service.PartnerReferrals.Contracts.V3.Referral Referral, [Optional]string MS-CorrelationId, [internal][Optional]string X-Caller-Id)

Create a referral

GetReferralById (string id, [internal]string content-type, [Optional]string MS-CorrelationId, [internal][Optional]string X-Caller-Id)

Get a referral by Id

UpdateReferralById (string id, Microsoft.Partner.Service.PartnerReferrals.Contracts.V3.Referral odataReferral, string if-match, [internal]string content-type, [Optional]string MS-CorrelationId, [internal][Optional]string X-Caller-Id)

Update a referral by Id

PatchReferralById (string id, [internal]string content-type, [Optional]string MS-CorrelationId, [internal][Optional]string X-Caller-Id, array Referral)

Update specific fields in a referral by Id

Name

Summary

Name

Summary

GetAllReferralsResponse

Microsoft.Partner.Service.PartnerReferrals.Contracts.V3.Referral

PatchReferralByIdParameterReferralItem

Name

Type

Summary

Required

Related Action

$expand

string

(Expand Query)

Expands related entities inline (default = none).

False

$filter

string

(Filter Query)

An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).

False

$select

string

(Select Query)

An ODATA select query to display which properties to include in the response.

False

$orderby

string

(Order By)

An ODATA orderBy query for specifying the order of entries.

False

$top

integer(int32)

(Top Count)

Total number of entries to retrieve (default = all).

False

$skip

integer(int32)

(Skip Count)

The number of entries to skip (default = 0).

False

$count

boolean

(Count)

Includes a count of the matching results in the response.

False

content-type

string

Content type of the request.

True

MS-CorrelationId

string

(Correlation ID)

The unique identifier to track the request.

False

X-Caller-Id

string

Optional, ID to identify the caller - Power Automate

False

Name

Type

Summary

Required

Related Action

Referral

Microsoft.Partner.Service.PartnerReferrals.Contracts.V3.Referral

True

MS-CorrelationId

string

(Correlation ID)

The unique identifier to track the request

False

X-Caller-Id

string

Optional, ID to identify the caller - Power Automate

False

Name

Type

Summary

Required

Related Action

id

string

(Referral ID)

Identifier of the referral.

True

content-type

string

Content type of the request.

True

MS-CorrelationId

string

(Correlation ID)

The unique identifier to track the request

False

X-Caller-Id

string

Optional, ID to identify the caller - Power Automate

False

Name

Type

Summary

Required

Related Action

id

string

(Referral ID)

The unique id for this referral.

True

odataReferral

Microsoft.Partner.Service.PartnerReferrals.Contracts.V3.Referral

True

if-match

string

(Used for if match header from the client)

Used for if match header from the client.

True

content-type

string

Content type of the request

True

MS-CorrelationId

string

(Correlation ID)

The unique identifier to track the request

False

X-Caller-Id

string

Optional, ID to identify the caller - Power Automate

False

Name

Type

Summary

Required

Related Action

id

string

(Referral ID)

The unique id for this referral

True

content-type

string

Content type of the request

True

MS-CorrelationId

string

(Correlation ID)

The unique identifier to track the request

False

X-Caller-Id

string

Optional, ID to identify the caller - Power Automate

False

Referral

array of (PatchReferralByIdParameterReferralItem)

Update Referral Details

True

Name

Type

Summary

@odata.context

string

OData context for this API call

@odata.count

integer(int32)

@odata.count

value

array of (Microsoft.Partner.Service.PartnerReferrals.Contracts.V3.Referral)

Name

Type

Summary

@odata.context

string

OData context for this API call

campaignId

string

Marketing Campaign ID

consent

Consent

consentObject

createdDateTime

string

Created Date Time

customerProfile

CustomerProfile

Details of the customer

details

Details

Details of referral

eTag

string

eTag

engagementId

string

Engagement ID

expirationDateTime

string

Expiration DateTime

externalReferenceId

string

External Reference ID

favorite

boolean

Mark This Referral As Favorite

id

string

Referral ID

inviteContext

InviteContext

Invite Context

lastModifiedVia

string

Referral Last Modified By

lastRunId

string

Identifier For The Last Run

links

Links

Links

name

string

Name

organizationId

string

Organization ID

organizationName

string

Organization Name

qualification

string

Qualification

referralProgram

string

Referral Program Name

salesStage

string

Sales Stage  Values: [Qualify, Develop, Propose, Close]

status

string

Status

statusReason

string

Status Reason

substatus

string

SubStatus

target

array of (TargetItem)

Target

team

array of (TeamItem)

Sales Team

trackingInfo

TrackingInfo

Referral Tracking Information

type

string

Type of Referral

updatedDateTime

string

Updated Date Time

Name

Type

Summary

consentToContact

boolean

Consent to Contact

consentToToShareInfoWithOthers

boolean

Consent to share info with others

consentToShareReferralWithMicrosoftSellers

boolean

Consent to share Referral with Microsoft Sellers

Name

Type

Summary

address

Address

Address of the customer

ids

array of (IdsItem)

CustomerProfileIDs

name

string

Customer Name

size

string

Customer Number of Employees

team

array of (TeamItem)

Customer Team

Name

Type

Summary

addressLine1

string

Customer Address Line 1

addressLine2

string

Customer Profile Address Line 2

city

string

Customer Profile City

country

string

Customer Profile Country

postalCode

string

Customer Profile Postal Code

region

string

Customer Profile Region

state

string

Customer Profile State

Name

Type

Summary

Name

Type

Summary

contactPreference

ContactPreference

Customer Team Contact Preference

email

string

Customer Team Email

firstName

string

Customer Team FirstName

lastName

string

Customer Team LastName

phoneNumber

string

Customer Team PhoneNumber

Name

Type

Summary

disableNotifications

boolean

Customer Team Contact Preference Disable Notifications

locale

string

Customer Team Contact Preference Locale

Name

Type

Summary

closingDateTime

string

Closing DateTime

currency

string

Currency

customerAction

string

Customer Action

customerRequestedContact

boolean

Has Customer Requested To Be Contacted

dealValue

number(float)

Deal Value

notes

string

Notes

requirements

Requirements

Referral Requirements

Name

Type

Summary

industries

array of (IndustriesItem)

Industries

products

array of (ProductsItem)

Products

services

array of (ServicesItem)

Services

solutions

array of (SolutionsItem)

Solutions

Name

Type

Summary

id

string

Industry Name

Name

Type

Summary

id

string

Products Name

Name

Type

Summary

id

string

Services Name

Name

Type

Summary

Name

Type

Summary

assistanceRequestCode

string

Assistance Request Code For This Referral  Values: [Unknown, GeneralOrOther, CustomerTechnicalArchitecture, ProofOfConceptOrDemo, QuotesOrLicensing, PostSalesCustomerSuccess, WorkloadSpecificValueProposition]

invitedBy

InvitedBy

Invited By

notes

string

Invite Context Notes

Name

Type

Summary

organizationId

string

Invited By Organization ID

organizationName

string

Invited By Organization Name

Name

Type

Summary

relatedReferrals

RelatedReferrals

Related Referrals

self

Self

Links Self

Name

Type

Summary

method

string

Links Related Referrals Method

uri

string

Links Related Referrals URI

Name

Type

Summary

method

string

Links Self Method

uri

string

Links Self URI

Name

Type

Summary

id

string

Target ID

type

string

Target Type

Name

Type

Summary

contactPreference

ContactPreference

Sales Team Contact Preference

email

string

Sales Team Email

firstName

string

Sales Team First Name

lastName

string

Sales Team Last Name

phoneNumber

string

Sales Team Phone Number

Name

Type

Summary

disableNotifications

boolean

Sales Team Disable Notifications

locale

string

Sales Team Contact Preference Locale

Name

Type

Summary

microsoftMsxId

string

Opportunity ID for the referral in Microsoft CRM

Name

Type

Summary

op

string

Update Operation

Choose an update (patch) operation  Values: [replace, add]

path

string

Field Path

Path to specific field within referral document for e.g. /details/notes  Values: [/campaignId, /consent/consentToShareReferralWithMicrosoftSellers, /customerProfile/team, /customerProfile/team/-, /details/closingDateTime, /details/currency, /details/dealValue, /details/notes, /details/requirements/solutions, /details/requirements/solutions/-, /externalReferenceId, /referralProgram, /salesStage, /status, /substatus, /statusReason, /team, /team/-]

value

Value

Value

New value to be replaced

Name

Type

Summary