Aktualisieren eines Lead oder einer Verkaufschance

Gilt für:

  • Partner-API

In diesem Thema wird erläutert, wie Sie den Lead oder die Verkaufschancedetails aktualisieren, z. B. den Dealwert, das geschätzte Abschlussdatum oder die Vertriebsphasen unter anderem.

Voraussetzungen

  • Anmeldeinformationen, wie unter Partner-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 Partner eine der folgenden Rollen haben müssen: Globaler Administrator, 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 findest du unter Partner-API: REST-Header.

Anforderungstext

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 Vorgänge und add .

Anforderungsbeispiel

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

[
    {
        "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 Parallelitätssteuerung verwendet.

REST-Antwort

Bei Erfolg enthält der Antwortkörper den aktualisierten Lead oder die Aktualisierte Verkaufschance.

Erfolgs- und Fehlercodes der Antwort

Jede Antwort enthält einen HTTP-Statuscode, der auf Erfolg oder Fehler sowie zusätzliche Debuginformationen hinweist. Verwende ein Tool für die Netzwerkablaufverfolgung, um diesen Code, den Fehlertyp und zusätzliche Parameter zu lesen.

Antwortbeispiel

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

Tipp

Der Antwortkörper hängt vom Prefer-Header ab. Wenn der Headerwert in der Anforderung weggelassen wird, ist der Antwortkörper mit dem HTTP-Statuscode 204 leer. Fügen Prefer: return=representation Sie dem Header hinzu, um den aktualisierten Lead oder die aktualisierte Verkaufschance zu erhalten.

Beispielanforderungen

  1. Aktualisiert den Dealwert für die Verkaufschance auf 10000 und aktualisiert die Hinweise. Aufgrund des Absenses des Headers gibt es keine If-Match Parallelitätsüberprü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 Lead oder einer Verkaufschance auf Gewonnen.

    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 status Felder und müssen dem substatus zulässigen Satz von Übergangswerten entsprechen, wie hier status

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

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