Aktualisieren eines Lead oder einer Verkaufschance (veraltet)

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.

Wichtig

Diese Methode zum Aktualisieren eines Lead oder einer Verkaufschance ist veraltet, und stattdessen wird der PATCH-Aufruf verwendet.

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
PUT https://api.partner.microsoft.com/v1.0/engagements/referrals/{Id}

Anforderungsheader

Wichtig

Der Header If-Match muss festgelegt werden.

Anforderungstext

In der folgenden Tabelle werden die Eigenschaften von Empfehlungsressourcen im Anforderungstext beschrieben:

Eigenschaft Typ BESCHREIBUNG
Id string Die ID für diese Empfehlung.
EngagementId Zeichenfolge Die Engagement-ID für diese Empfehlung. Mehrere Empfehlungen können einer einzelnen Engagement-ID zugeordnet sein.
Name string Der Name der Empfehlung.
ExternalReferenceId string Ein externer Bezeichner für die Empfehlung. Beispiel: Store Ihre eigene Dynamics 365-Lead-/Verkaufschance-ID
CreatedDateTime Zeichenfolge im UTC-Zeitformat (Datum und Uhrzeit) Das Erstellungsdatum der Empfehlung.
UpdatedDateTime Zeichenfolge im UTC-Zeitformat (Datum und Uhrzeit) Das Datum, an dem die Empfehlung zuletzt aktualisiert wurde.
ExpirationDateTime Zeichenfolge im UTC-Zeitformat (Datum und Uhrzeit) Das Datum, an dem die Empfehlung abläuft.
Status ReferralStatus Eine Enumeration mit Werten, die den Status der Empfehlung angeben.
Substatus ReferralSubstatus Eine Enumeration mit Werten, die den Substatus der Empfehlung angeben.
StatusReason string Eine beschreibende Statusmeldung. Erläutere beispielsweise, warum die Empfehlung nicht erfolgreich war.
ReferralType ReferralType Stellt die Art der Empfehlung dar.
Qualification ReferralQualification Stellt die Qualität der Empfehlung dar.
CustomerProfile CustomerProfile Die Kontaktinformationen des Kunden.
Consent Consent Zustimmungsflags hinsichtlich der Weitergabe von Informationen an andere Organisationen und der Erlaubnis, Kontakt mit Benutzern aufzunehmen.
Details ReferralDetails Kundendetails, Hinweise, Wert des Geschäfts, Währung und Enddatum.
Team Member Stellt Benutzer in den Organisationen dar, die an dem Partner-Engagement beteiligt sind.
InviteContext InviteContext Stellt zusätzliche Informationen dar, die ein Benutzer angeben kann, wenn er eine weitere Organisation zum Partner-Engagement einlädt.
Ziel ReferralTarget Stellt zusätzliche Informationen dar, die ein Benutzer angeben kann, wenn er eine weitere Organisation zum Partner-Engagement einlädt.

Übergangszustände für Status und Substatus

Status Zulässiger Statusübergang Zulässiger Substatus
„Neu“, New, Active, Closed Pending, Received
Aktiv Active, Closed Accepted
Geschlossen Geschlossen Gewonnen, verloren, abgelehnt, abgelaufen

Anforderungsbeispiel

PUT https://api.partner.microsoft.com/v1.0/engagements/referrals/49d90c72-3326-4f61-aacc-2cb57970448c HTTP/1.1
Authorization: Bearer <token>
Host: api.partner.microsoft.com
Content-Type: application/json

 {
    "id": "49d90c72-3326-4f61-aacc-2cb57970448c",
    "engagementId": "37ef26aa-1d15-4533-9f93-a69bd33ab1e5",
    "createdDateTime": "2018-11-06T18:40:42.6178337Z",
    "updatedDateTime": "2018-11-06T18:40:42.6178337Z",
    "expirationDateTime": "2018-11-14T00:00:00Z",
    "status": "Closed",
    "substatus": "Won",
    "statusReason": "Customer engagement was a success!",
    "qualification": "SalesQualified",
    "type": "Independent",
    "target": [
        {
            "type": "BusinessProfileLocation",
            "id": "01e2abcd-52b0-4af3-a3ae-1fd1530b3563"
        }
    ],
    "customerProfile": {
        "name": "Contoso Customer Inc",
        "address": {
            "addressLine1": "One Microsoft Way",
            "addressLine2": "34",
            "city": "Redmond",
            "state": "WA",
            "postalCode": "98052",
            "country": "US"
        },
        "size": "10to50employees",
        "team": [
            {
                "contactPreference": {
                    "locale": "en-us",
                    "disableNotifications": false
                },
                "firstName": "Sue",
                "lastName": "Smith",
                "phoneNumber": "1234567890",
                "email": "sue.smith@contoso.com"
            },
            {
                "contactPreference": {
                    "locale": "en-us",
                    "disableNotifications": false
                },
                "firstName": "Joe",
                "lastName": "Hansen",
                "phoneNumber": "4035698759",
                "email": "joe.hansen@contoso.com"
            }
        ],
        "ids": []
    },
    "consent": {
        "consentToToShareInfoWithOthers": true,
        "consentToContact": true
    },
    "details": {
        "notes": "Customer is looking to leverage Dynamics 365 to manage their supply chain. There is also a need to leverage a set of custom apps to enable their business processes.",
        "dealValue": 50000,
        "currency": "USD",
        "closingDateTime": "2018-11-14T00:00:00Z",
        "requirements": {
            "industries": [
                {
                    "id": "Manufacturing"
                }
            ],
            "products": [
                {
                    "id": "Dynamics365Enterprise"
                }
            ],
            "services": [
                {
                    "id": "DeploymentOrMigration"
                }
            ],
            "solutions": [
                {
                    "name": "Dynamics 365 for Field Service",
                    "type": "Category",
                    "id": "Dynamics365forFieldService"
                }
            ]
        }
    },
    "team": [
        {
            "contactPreference": {
                "locale": "en-us",
                "disableNotifications": false
            },
            "firstName": "John",
            "lastName": "Doe",
            "phoneNumber": "1231231234",
            "email": "john.doe@microsoft.com"
        }
    ],
    "inviteContext": {
        "notes": "Hi ABC Partner, hoping you can help this customer. Thanks, John @ Microsoft",
        "invitedBy": {
            "organizationId": "msft"
        }
    },
    "eTag": "\"2500ec5a-0000-0000-0000-5bf4967d0000\"",

}

Wichtig

Entferne das Objekt "links": { } aus der PUT-Ressource.

REST-Antwort

Bei Erfolg gibt diese Methode die aufgefüllte Empfehlungsressource im Antwortkörper zurück.

Erfolgs- und Fehlercodes der Antwort

Jede Antwort enthält einen HTTP-Statuscode, der Aufschluss darüber gibt, ob der Vorgang erfolgreich war, sowie ggf. zusätzliche Debuginformationen. Verwende ein Tool für die Netzwerkablaufverfolgung, um diesen Code, den Fehlertyp und zusätzliche Parameter zu lesen. Die vollständige Liste findest du unter Partner-API: REST-Fehlercodes.

Antwortbeispiel

{
    "id": "4111fffc-f9ee-4d53-bba6-569135228642",
    "organizationId": "7d23e5ca-19dc-4eaa-aac8-5e6b559f0d1d",
    "organizationName": "Contoso Company",
    "engagementId": "37ef26aa-1d15-4533-9f93-a69bd33ab1e5",
    "createdDateTime": "2018-11-06T18:40:42.6178337Z",
    "updatedDateTime": "2018-11-06T18:43:38.9948636Z",
    "expirationDateTime": "2018-11-14T00:00:00Z",
    "status": "Closed",
    "substatus": "Won",
    "statusReason": "Customer engagement was a success!",
    "qualification": "SalesQualified",
    "type": "Independent",
    "target": [
        {
            "type": "BusinessProfileLocation",
            "id": "01e2abcd-52b0-4af3-a3ae-1fd1530b3563"
        }
    ],
    "customerProfile": {
        "name": "Contoso Customer Inc",
        "address": {
            "addressLine1": "One Microsoft Way",
            "addressLine2": "34",
            "city": "Redmond",
            "state": "WA",
            "postalCode": "98052",
            "country": "US"
        },
        "size": "10to50employees",
        "team": [
            {
                "contactPreference": {
                    "locale": "en-us",
                    "disableNotifications": false
                },
                "firstName": "Sue",
                "lastName": "Smith",
                "phoneNumber": "1234567890",
                "email": "sue.smith@contoso.com"
            },
            {
                "contactPreference": {
                    "locale": "en-us",
                    "disableNotifications": false
                },
                "firstName": "Joe",
                "lastName": "Hansen",
                "phoneNumber": "4035698759",
                "email": "joe.hansen@contoso.com"
            }
        ],
        "ids": []
    },
    "consent": {
        "consentToToShareInfoWithOthers": true,
        "consentToContact": true
    },
    "details": {
        "notes": "Customer is looking to leverage Dynamics 365 to manage their supply chain. There is also a need to leverage a set of custom apps to enable their business processes.",
        "dealValue": 50000,
        "currency": "USD",
        "requirements": {
            "industries": [
                {
                    "id": "Manufacturing"
                }
            ],
            "products": [
                {
                    "id": "Dynamics365Enterprise"
                }
            ],
            "services": [
                {
                    "id": "DeploymentOrMigration"
                }
            ],
            "solutions": [
                {
                    "name": "Dynamics 365 for Field Service",
                    "type": "Category",
                    "id": "Dynamics365forFieldService"
                }
            ]
        }
    },
    "team": [
        {
            "contactPreference": {
                "locale": "en-us",
                "disableNotifications": false
            },
            "firstName": "John",
            "lastName": "Doe",
            "phoneNumber": "1231231234",
            "email": "john.doe@microsoft.com"
        }
    ],
    "inviteContext": {
        "notes": "Hi ABC Partner, hoping you can help this customer. Thanks, John @ Microsoft",
        "invitedBy": {
            "organizationId": "msft"
        }
    },
    "eTag": "\"2500ec5a-0000-0000-0000-5bf4967d0000\"",
    "links": {
        "relatedReferrals": {
            "uri": "https://api.partner.microsoft.com/v1.0/engagments/referrals?$filter=engagementId eq '37ef26aa-1d15-4533-9f93-a69bd33ab1e5'",
            "method": "GET"
        },
        "self": {
            "uri": "https://api.partner.microsoft.com/v1.0/engagments/referrals/4111fffc-f9ee-4d53-bba6-569135228642",
            "method": "GET"
        }
    }
}