Partager via

Mettre à jour un prospect ou une opportunité

  • Article

Cet article explique comment mettre à jour les détails des prospects ou des opportunités, comme la valeur de transaction, la date de clôture estimée ou gérer les étapes de vente entre autres détails.

Prérequis

  • Informations d’identification, comme décrit dans l’authentification de l’API Références. Ce scénario prend en charge l’authentification avec les informations d’identification de l’application et de l’utilisateur.
  • Cette API prend actuellement en charge uniquement l’accès utilisateur où les partenaires doivent se trouver dans l’un des rôles suivants : Administrateur de référence ou Utilisateur de référence.

Demande REST

Syntaxe de la requête

Method URI de demande
PATCH https://api.partner.microsoft.com/v1.0/engagements/referrals/{ID}

Paramètre d’URI

Nom Type Requise Description
id string Oui Identificateur unique d’une opportunité de prospect ou de co-vente

En-têtes de requête

Pour plus d’informations, consultez les en-têtes REST du partenaire.

Corps de la demande

Le corps de la requête suit le format de correctif Json. Un document JSON Patch possède un tableau des opérations. Chaque opération identifie un type particulier de changement. Des exemples de telles modifications incluent l'ajout d'un élément de tableau ou le remplacement d'une valeur de propriété.

Important

Actuellement, l’API prend uniquement en charge les opérations et add les replace opérations.

Exemple de requête

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

Remarque

Si l’en-tête If-Match est passé, il est utilisé pour le contrôle d’accès concurrentiel.

Réponse REST

En cas de réussite, le corps de la réponse contient le prospect ou l’opportunité mis à jour.

Codes d’erreur et de réussite de la réponse

Chaque réponse est fournie avec un code d’état HTTP qui indique la réussite ou l’échec et d’autres informations de débogage. Utilisez un outil de suivi réseau pour lire ce code, le type d’erreur et d’autres paramètres.

Exemple de réponse

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

Conseil

Le corps de la réponse dépend de l’en-tête Prefer . Si la valeur d’en-tête est omise dans la requête, le corps de la réponse est vide avec un code d’état HTTP 204. Ajoutez Prefer: return=representation à l’en-tête pour obtenir le prospect ou l’opportunité mis à jour.

Exemples de demandes

  1. Met à jour la valeur de transaction pour l’opportunité de 1 0000 et met à jour les notes. Il n’existe aucune vérification de concurrence en raison de l’absence de l’en-tête 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. Met à jour l’état d’un prospect ou d’une opportunité de 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"}
]

    Important

    Les status champs et substatus les champs doivent être conformes à l’ensemble autorisé de valeurs de transition.

  3. Ajoute un nouveau membre de votre organisation à l’équipe responsable ou opportunité. La réponse contient le prospect ou l’opportunité mis à jour en raison de la présence de l’en-tête 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"
        }
    }
]

Contenu connexe