Update a referral

post

https://msft.cosell.tackle.io/api/referrals/{referral_id}

Update a referral. The behavior of the request depends on the
tackle-operation-id header. Sub-operations that look up the
referral by ID -- in particular requestSyncFromSalesforce --
may return 404 Not Found when the referral does not exist for
the authenticated vendor.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

referral_id

string

required

The unique identifier for the referral

Body Params

name

string

The name of the Referral

campaignId

string

Marketing campaign ID.

salesStage

string

Microsoft Partner Center sales-stage code, transmitted as a
string. Microsoft's published stages map to:

10 -- Accepted
20 -- Qualified
40 -- Developed
60 -- Proposed
80 -- Negotiated
100 -- Won

Microsoft-defined stage codes outside this list are accepted
and forwarded unchanged, so treat the value as free-form on
the client.

consent

object

Consent flags around sharing information with other organizations and allowing them to contact users. Required.

details

object

Customer details, notes, deal value, currency closing date. Required.

team

array of objects

required

Represents users in the organizations that are involved in the partner engagement. Can be used when updating or accepting a referral.

team*

inviteContexts

array of objects

Include to invite Microsoft or another organization to the deal.

inviteContexts

Headers

tackle-operation-id

string

enum

required

Identifier for the sub-operation to perform when updating
the referral. Required. The value selects the request body
schema and the side-effect -- see the request-body examples
for a payload per value.

updateIPReferral -- update fields on an active outbound IP referral. Body: UpdateReferralInput.
updateDraftIPReferral -- update fields on a draft referral that has not been submitted to Microsoft. Body: CreateReferralInput.
createIPReferralFromDraft -- submit a previously-saved draft to Microsoft Partner Center. Body: CreateReferralInput.
retryCreateIPReferral -- retry a failed create. Body: CreateReferralInput.
closeWonReferral -- mark the referral closed-won. Body: {}.
closeLostReferral -- mark the referral closed-lost. Body: StatusChangedInput with statusReason.
closeErrorReferral -- mark the referral closed-error. Body: StatusChangedInput with statusReason.
acceptIncomingReferral -- accept an inbound referral shared by Microsoft. Body: StatusChangedInput; supply team if the referral has none.
declineIncomingReferral -- decline an inbound referral. Body: StatusChangedInput with statusReason.
updateReferralCRMID -- update the CRM linkage only; does not call Microsoft. Body: StatusChangedInput with crmId / crmOrgId.
resyncReferralToCRM -- re-push the latest referral state to your CRM. Body: {}. Does not call Microsoft.
requestSyncFromSalesforce -- pull the latest state from Salesforce. Body: {}. Does not call Microsoft. Returns 404 when the referral is not found for the authenticated vendor.

Responses

404

The requested resource was not found.

The response body shape depends on the operation:

Read operations (for example getReferral) return an empty body
(no JSON envelope).
Write operations that look up a resource by ID before acting on it
(for example updateIPReferral with tackle-operation-id: requestSyncFromSalesforce) return a JSON envelope of the form
{"message": "Referral not found"}.

500

An unexpected error occurred while processing the request. The response body is
empty.

202Accepted

400The request was malformed or could not be processed. Returned when the JSON body cannot be parsed, when a required field is missing, when an unsupported tackle-operation-id is supplied, or when a referenced CRM ID is invalid.

401The request did not include a valid Tackle MTM access token, so no principal could be established. The response body is {} — the message field is omitted.

403The authenticated principal does not have permission to perform this operation. The response body is {} — the message field is omitted.

409The request conflicts with an existing resource. For example, attempting to create or accept a referral with a CRM ID that is already linked to another co-sell opportunity.