Udostępnij za pośrednictwem

Aktualizowanie potencjalnego klienta lub szansy sprzedaży

  • Artykuł

W tym artykule wyjaśniono, jak zaktualizować szczegóły potencjalnych klientów lub szans sprzedaży, takie jak wartość transakcji, szacowana data zamknięcia lub zarządzanie etapami sprzedaży między innymi szczegółami.

Wymagania wstępne

  • Poświadczenia zgodnie z opisem w temacie Uwierzytelnianie interfejsu API poleceń. Ten scenariusz obsługuje uwierzytelnianie przy użyciu poświadczeń aplikacji i użytkownika.
  • Ten interfejs API obsługuje obecnie tylko dostęp użytkowników, w których partnerzy muszą należeć do jednej z następujących ról: Administrator poleceń lub Użytkownik poleceń.

Żądanie REST

Składnia żądania

Method Identyfikator URI żądania
PATCH https://api.partner.microsoft.com/v1.0/engagements/referrals/{ID}

Parametr identyfikatora URI

Nazwisko Type Wymagania Opis
IDENTYFIKATOR string Tak Unikatowy identyfikator szansy sprzedaży lub wspólnej sprzedaży

Nagłówki żądań

Aby uzyskać więcej informacji, zobacz Nagłówki REST partnera.

Treść żądania

Treść żądania jest zgodna z formatem poprawki Json. Dokument poprawki JSON zawiera tablicę operacji. Każda operacja identyfikuje określony typ zmiany. Przykłady takich zmian obejmują dodanie elementu tablicy lub zastąpienie wartości właściwości.

Ważne

Interfejs API obsługuje replace obecnie tylko operacje i add .

Przykład żądania

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"
        }
    }
]

Uwaga

Jeśli nagłówek If-Match zostanie przekazany, zostanie użyty do sterowania współbieżnością.

Odpowiedź REST

W przypadku powodzenia treść odpowiedzi zawiera zaktualizowanego potencjalnego klienta lub szansę sprzedaży.

Kody powodzenia i błędów odpowiedzi

Każda odpowiedź zawiera kod stanu HTTP, który wskazuje powodzenie lub niepowodzenie i inne informacje o debugowaniu. Użyj narzędzia do śledzenia sieci, aby odczytać ten kod, typ błędu i inne parametry.

Przykład odpowiedzi

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

Napiwek

Treść odpowiedzi zależy od nagłówka Preferuj. Jeśli wartość nagłówka zostanie pominięta w żądaniu, treść odpowiedzi jest pusta z kodem stanu HTTP 204. Dodaj Prefer: return=representation do nagłówka, aby uzyskać zaktualizowanego potencjalnego klienta lub szansę sprzedaży.

Przykładowe żądania

  1. Aktualizuje wartość transakcji dla szansy sprzedaży na 10000 i aktualizuje notatki. Brak kontroli współbieżności z powodu braku nagłówka If-Match .

    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. Aktualizuje stan potencjalnego klienta lub szansy sprzedaży na wygraną.

    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"}
]

    Ważne

    Pola status i substatus powinny być zgodne z dozwolonym zestawem wartości przejścia.

  3. Dodaje nowego członka z organizacji do zespołu potencjalnych klientów lub szans sprzedaży. Odpowiedź zawiera zaktualizowanego potencjalnego klienta lub szansę sprzedaży ze względu na obecność nagłówka Prefer: return=representation .

    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"
        }
    }
]

Powiązana zawartość