リードまたは営業案件を更新する

この記事では、案件の値、見積もり終了日などの潜在顧客または営業案件の詳細を更新する方法、または他の詳細の中から販売ステージを管理する方法について説明します。

前提条件

• Referrals API 認証で説明されている資格情報。 このシナリオでは、アプリとユーザーの資格情報を使用した認証がサポートされます。
• 現在、この API では、パートナーが紹介管理者または紹介ユーザーのいずれかのロールに含まれている必要があるユーザー アクセスのみがサポートされています。

REST 要求

要求の構文

URI パラメーター

要求ヘッダー

詳細については、「 Partner REST ヘッダー」を参照してください。

要求本文

要求本文は、 Json Patch 形式に従います。 JSON パッチ ドキュメントには、"操作" の配列が含まれます。 各操作により、特定の種類の変更が識別されます。 このような変更の例としては、配列要素の追加やプロパティ値の置き換えがあります。

要求の例

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

REST 応答

成功した場合、応答本文には更新された リードまたは営業案件が含まれます。

応答の成功とエラーのコード

各応答には、成功または失敗とその他のデバッグ情報を示す HTTP 状態コード が付属しています。 ネットワーク トレース ツールを使用して、このコード、エラーの種類、およびその他のパラメーターを読み取ります。

応答の例

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

サンプルの要求

1. 営業案件の取引額を 10000 に更新し、メモを更新します。 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. リードまたは営業案件の状態を [ウォン] に更新します。

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

   重要

   statusフィールドとsubstatus フィールドは、許可されるトランザクション値のセットに準拠している必要があります。

3. 組織の新しいメンバーをリードチームまたは営業案件チームに追加します。 応答には、 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"
           }
       }
   ]
   

関連するコンテンツ

• 紹介を作成する