Condividi tramite

Aggiornare un lead o un'opportunità

  • Articolo

Questo articolo illustra come aggiornare i dettagli del lead o dell'opportunità, ad esempio il valore della trattativa, la data di chiusura stimata o gestire le fasi di vendita tra gli altri dettagli.

Prerequisiti

  • Credenziali descritte in Autenticazione dell'API Segnalazioni. Questo scenario supporta l'autenticazione con le credenziali dell'app e dell'utente.
  • Questa API supporta attualmente solo l'accesso utente in cui i partner devono trovarsi in uno dei ruoli seguenti: Amministratore delle segnalazioni o Utente segnalazione.

Richiesta REST

Sintassi della richiesta

metodo URI della richiesta
PATCH https://api.partner.microsoft.com/v1.0/engagements/referrals/{ID}

Parametro URI

Nome Digita Obbligatorio Descrizione
ID string Sì Identificatore univoco per un'opportunità di co-selling o lead

Intestazioni delle richieste

Per altre informazioni, vedere Intestazioni REST dei partner.

Testo della richiesta

Il corpo della richiesta segue il formato Json Patch . Un documento JSON Patch è una matrice di operazioni. Ogni operazione identifica un particolare tipo di modifica. Esempi di tali modifiche includono l'aggiunta di un elemento matrice o la sostituzione di un valore della proprietà.

Importante

L'API supporta attualmente solo le replace operazioni e add .

Esempio di richiesta

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

Nota

Se viene passata l'intestazione If-Match , verrà usata per il controllo della concorrenza.

Risposta REST

In caso di esito positivo, il corpo della risposta contiene il lead o l'opportunità aggiornati.

Codici di errore e di esito della risposta

Ogni risposta viene fornita con un codice di stato HTTP che indica l'esito positivo o negativo e altre informazioni di debug. Usare uno strumento di traccia di rete per leggere questo codice, il tipo di errore e altri parametri.

Risposta di esempio

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

Suggerimento

Il corpo della risposta dipende dall'intestazione Prefer . Se il valore dell'intestazione viene omesso nella richiesta, il corpo della risposta è vuoto con un codice di stato HTTP 204. Aggiungere Prefer: return=representation all'intestazione per ottenere il lead o l'opportunità aggiornati.

Richieste di esempio

  1. Aggiorna il valore della trattativa per l'opportunità a 10000 e aggiorna le note. Non sono presenti controlli di concorrenza a causa dell'assenza dell'intestazione 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. Aggiorna lo stato di un lead o di un'opportunità a 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"}
]

    Importante

    I status campi e substatus devono essere conformi al set consentito di valori di transizione.

  3. Aggiunge un nuovo membro dell'organizzazione al team responsabile o all'opportunità. La risposta contiene il lead o l'opportunità aggiornati a causa della presenza dell'intestazione 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"
        }
    }
]

Contenuto correlato