Freigeben über

Aktualisieren eines Lead oder einer Verkaufschance

  • Artikel

In diesem Artikel wird erläutert, wie Sie die Lead- oder Verkaufschancendetails wie den Dealwert, den geschätzten Abschlusstermin oder die Vertriebsphasen unter anderen Details aktualisieren.

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 Type Erforderlich Beschreibung
id Zeichenfolge Ja Der eindeutige Bezeichner für eine Lead- oder Co-Sell-Verkaufschance

Anforderungsheader

Weitere Informationen finden Sie unter Partner-REST-Headern.

Anforderungstext

Der Anforderungstext 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 und add die replace 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 das Parallelitätssteuerelement 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 Fehler und 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 Verkaufschance 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 und substatus Felder status 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 aufgrund 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"
        }
    }
]

Zugehöriger Inhalt