Aktualisieren eines Leads oder einer Verkaufschance

In diesem Artikel wird erläutert, wie Sie die Lead- oder Gelegenheitendetails aktualisieren, z. B. Details wie den Dealwert, den geschätzten Abschlusstermin oder die Verwaltung der Vertriebsphasen.

Voraussetzungen

  • Anmeldeinformationen, wie in der Empfehlungs-API-Authentifizierung beschrieben. In diesem Szenario wird die Authentifizierung mit App- und Benutzeranmeldeinformationen unterstützt.
  • Diese API unterstützt derzeit nur den Benutzerzugriff, bei dem Sich Partner in einer der folgenden Rollen befinden müssen: Empfehlungsadministrator oder Empfehlungsbenutzer.

REST-Anforderung

Anforderungssyntax

Methode Anforderungs-URI
PATCH https://api.partner.microsoft.com/v1.0/engagements/referrals/{ID}

URI-Parameter

Name Typ Erforderlich Beschreibung
id Zeichenfolge Ja Der eindeutige Bezeichner für eine Lead- oder Co-Sell-Verkaufschance

Anforderungsheader

Weitere Informationen finden Sie unter Partner-REST-Header.

Anforderungstextkörper

Der Anforderungskörper folgt dem JSON Patch-Format. Ein JSON Patch-Dokument verfügt über ein Array von Vorgängen. Jeder Vorgang identifiziert einen bestimmten Änderungstyp. Beispiele für solche Änderungen sind das Hinzufügen eines Arrayelements oder das Ersetzen eines Eigenschaftswerts.

Wichtig

Die API unterstützt derzeit nur die replace- und add-Vorgänge.

Anforderungsbeispiel

PATCH https://api.partner.microsoft.com/v1.0/engagements/referrals/{ID} HTTP/1.1
Authorization: Bearer <token>
Prefer: return=representation
Content-Type: application/json

[
    {
        "op": "replace",
        "path": "/details/dealValue",
        "value": "10000"
    },
    {
        "op": "add",
        "path": "/team/-",
        "value": {
            "email": "jane.doe@contoso.com",
            "firstName": "Jane",
            "lastName": "Doe",
            "phoneNumber": "0000000001"
        }
    }
]

Hinweis

Wenn der If-Match Header übergeben wird, wird er für die Nebenläufigkeitskontrolle verwendet.

REST-Antwort

Bei erfolgreicher Ausführung enthält der Antworttext den aktualisierten Lead oder die aktualisierte Verkaufschance.

Erfolgs- und Fehlercodes der Antwort

Jede Antwort enthält einen HTTP-Statuscode, der Erfolg oder Misserfolg sowie andere Debuginformationen angibt. Verwenden Sie ein Netzwerkablaufverfolgungstool, um diesen Code, den Fehlertyp und andere Parameter zu lesen.

Beispielantwort

HTTP/1.1 204 No Content
Content-Length: 0
Request-ID: 9f8bed52-e4df-4d0c-9ca6-929a187b0731

Tipp

Der Antworttext hängt vom Prefer-Header ab. Wenn der Headerwert in der Anforderung nicht angegeben wird, ist der Antworttext leer mit einem HTTP-Statuscode 204. Fügen Sie Prefer: return=representation der Kopfzeile hinzu, um den aktualisierten Lead oder die aktualisierte Opportunity zu erhalten.

Beispielanforderungen

  1. Aktualisiert den Dealwert für die Gelegenheit auf 10000 und aktualisiert die Notizen. Aufgrund des Fehlens der If-Match Kopfzeile gibt es keine Parallelitätsprüfungen.

    PATCH https://api.partner.microsoft.com/v1.0/engagements/referrals/{ID}
    Authorization: Bearer <token>
    Content-Type: application/json
    
    [
        {"op":"replace","path":"/details/dealValue","value":"10000"},
        {"op":"replace","path":"/details/notes","value":"Lorem ipsum dolor sit amet."}
    ]
    
  2. Aktualisiert den Status eines Leads oder einer Verkaufschance für Won.

    PATCH https://api.partner.microsoft.com/v1.0/engagements/referrals/{ID}
    Authorization: Bearer <token>
    Content-Type: application/json
    
    [
        {"op":"replace", "path":"/status", "value":"Closed"},
        {"op":"replace", "path":"/substatus", "value":"Won"}
    ]
    

    Wichtig

    Die Felder status und substatus sollten den zulässigen Übergangswerten entsprechen.

  3. Fügt dem Lead- oder Verkaufschancenteam ein neues Mitglied aus Ihrer Organisation hinzu. Die Antwort enthält den aktualisierten Lead oder die aktualisierte Verkaufschance wegen des Vorhandenseins des Prefer: return=representation Headers.

    PATCH https://api.partner.microsoft.com/v1.0/engagements/referrals/{ID} HTTP/1.1
    Authorization: Bearer <token>
    Prefer: return=representation
    Content-Type: application/json
    
    [
        {
            "op": "add",
            "path": "/team/-",
            "value": {
                "email": "jane.doe@contoso.com",
                "firstName": "Jane",
                "lastName": "Doe",
                "phoneNumber": "0000000001"
            }
        }
    ]
    

Dealregistrierungen erstellen

Verwenden Sie die DealRegistrierungs-API, um eine Dealregistrierung im Partner Center zu erstellen, wenn sowohl der Partner als auch die Empfehlung berechtigt sind. Weitere Informationen zu Deal-Registrierungskonzepten und -workflows finden Sie unter Registrieren von Deals im Partner Center.

Berechtigungsanforderungen

  • Der Partner muss basierend auf den Berechtigungskriterien von Microsoft für die Dealregistrierung genehmigt werden.
  • Die Empfehlung muss die Registrierung von Deals unterstützen.

Wie funktioniert die Berechtigung?

  • Die Partnerberechtigung wird von Microsoft bestimmt und wird nicht über den Partner Center-Empfehlungsarbeitsbereich verwaltet.
  • Sie können die Partnerberechtigung programmgesteuert überprüfen, indem Sie die Berechtigungs-API für Partner-Deal-Registrierung aufrufen, bevor Sie eine Dealregistrierung erstellen.
  • Die API-Antwort gibt an, ob der Aufrufer die Registrierungserstellung fortsetzen darf.

Die Berechtigungsanforderungen stellen sicher, dass nur berechtigte Partner Deals registrieren können und hilft, fehlgeschlagene oder ungültige Übermittlungen zu verhindern.

Berechtigungs-API für Partner-Deal-Registrierung

Anforderungssyntax

Methode Anforderungs-URI
GET https://api.partner.microsoft.com/v1.0/engagements/partners/dealregistrationeligibility

Anforderungsbeispiel

GET https://api.partner.microsoft.com/v1.0/engagements/partners/dealregistrationeligibility HTTP/1.1
Authorization: Bearer <token>
Prefer: return=representation

REST-Antwort

Bei erfolgreicher Ausführung enthält der Antworttext den Berechtigungsstatus.

Erfolgs- und Fehlercodes der Antwort

Jede Antwort enthält einen HTTP-Statuscode, der Erfolg oder Misserfolg sowie Debugging-Informationen angibt. Verwenden Sie ein Netzwerkablaufverfolgungstool, um diesen Code, den Fehlertyp und alle Parameter zu lesen.

Beispielantwort

HTTP/1.1 200 OK
Request-ID: 2d1bed51-2fd9-adfc-h4a7-019kk87c0627
Content-Type: application/json

{
  "isEligible": true,
  "policies": [
    {
      "isEligible": true
    }
  ]
}

Berechtigung zur Registrierung von Empfehlungsgeschäften

Eine Empfehlung ist für die Registrierung von Deals berechtigt, wenn alle folgenden Bedingungen erfüllt sind:

  • Der Dealtyp ist Co-Sell.
  • Der Kunde ist Microsoft Managed.
  • Der Gesamt-Deal-Wert ist größer als 25.000 USD.
  • Mindestens eine zugeordnete Lösung ist Azure IP Co-sell-fähig.
  • Der Microsoft-Empfehlungsstatus ist akzeptiert.

Sie können die Berechtigung für Empfehlungen auch programmgesteuert überprüfen, indem Sie die Berechtigungs-API für die Deal-Registrierung aufrufen. Die API-Antwort bestätigt, ob eine bestimmte Co-Sell-Empfehlung für die Registrierung von Deals qualifiziert ist.

Berechtigungs-API für Deal Registration

Anforderungssyntax

Methode Anforderungs-URI
POST https://api.partner.microsoft.com/v1.0/engagements/referrals/{ID}/dealregistrations/eligibility

URI-Parameter

Name Typ Erforderlich Beschreibung
id Zeichenfolge Ja Der eindeutige Bezeichner für eine Co-Selling-Möglichkeit

Anforderungsbeispiel

POST https://api.partner.microsoft.com/v1.0/engagements/referrals/{ID}/dealregistrations/eligibility HTTP/1.1
Authorization: Bearer <token>
Prefer: return=representation

Hinweis

Obwohl es sich um eine POST-Anforderung handelt, gibt es keine Nutzlast, die für diese HTTP-Anforderung bereitgestellt werden soll.

REST-Antwort

Wenn der Antworttext erfolgreich verläuft, enthält der Antworttext den Berechtigungsstatus und den Satz fehlgeschlagener und bestandener Berechtigungsrichtlinien.

Erfolgs- und Fehlercodes der Antwort

Jede Antwort enthält einen HTTP-Statuscode, der Erfolg oder Fehler sowie Debugging-Informationen anzeigt. Verwenden Sie ein Netzwerkablaufverfolgungstool, um diesen Code, den Fehlertyp und alle Parameter zu lesen.

Beispielantwort

HTTP/1.1 200 OK
Request-ID: 9f8bed52-e4df-4d0c-9ca6-929a187b0731
Content-Type: application/json

{
  "isEligible": true,
  "passedPolicies": [
    {
      "policyName": "isDealTypeCosellOrPartnerLed",
      "isEligible": true,
      "referralProperties": {
        "type": "Shared"
      }
    },
    {
      "policyName": "isMicrosoftReferralAcceptedOrWon",
      "isEligible": true,
      "referralProperties": {
        "status": "Active",
        "substatus": "Accepted"
      }
    },
    {
      "policyName": "isSolutionIncentiveEligible",
      "isEligible": true,
      "referralProperties": {
        "solutionId": "DEAL-123456-XYZ",
        "solutionName": "Contoso Experience Platform"
      },
      "additionalProperties": [
        "MSFT Internal Azure IP Co-Sell"
      ]
    },
    {
      "policyName": "isDealValueEligible",
      "isEligible": true,
      "referralProperties": {
        "currency": "USD",
        "dealValue": "30000"
      }
    },
    {
      "policyName": "isCustomerManaged",
      "isEligible": true,
      "referralProperties": {
        "isMatchingComplete": "true"
      },
      "additionalProperties": [
        "Managed"
      ]
    }
  ],
  "failedPolicies": []
}

Registrierung von Verkaufschancen API

Verwenden Sie den vorhandenen Deal Update-Vorgang (PATCH-API), um eine Dealregistrierung zu erstellen.

Anforderungsbeispiel

PATCH https://api.partner.microsoft.com/v1.0/engagements/referrals/{ID} HTTP/1.1
Authorization: Bearer <token>
Prefer: return=representation
Content-Type: application/json

[
    {
        "op":"add",
        "path":"/registrations/-",
        "value":{
            "type":"AzureIPCoSell",
            "contract":{
                "currency":"USD",
                "endDateTime":"2026-02-28T09:14:19.454Z",
                "signDateTime":"2026-02-12T09:14:10.783Z",
                "startDateTime":"2026-02-12T09:14:16.319Z",
                "term":"Finite",
                "value":250000
            },
            "solutionDetails":[
                {
                    "id":"DEAL-123456-XYZ",
                    "isDeployedOnAzure":true,
                    "marketplaceTransactionDetails":{
                        "isMarketplaceTransacted":true,
                        "marketplaceTransactionDateTime":"2026-02-11T09:13:52.105Z"
                    },
                    "primaryDeploymentOn":"Partner",
                    "pricingModel":"Other",
                    "value":250000,
                    "currency":"USD"
                }
            ]
        }
    }
]

Beispielantwort

HTTP/1.1 204 No Content
Content-Length: 0
Request-ID: 9f8bed52-e4df-4d0c-9ca6-929a187b0731

Hinweis

Sobald eine erfolgreiche Ausführungsantwort empfangen wurde, kann Partner die Quellempfehlung abrufen, um die erstellte Dealregistrierung zu sehen.