共用方式為

更新潛在客戶或商機

  • 發行項

本文說明如何更新潛在客戶或商機詳細數據，例如交易值、估計的關閉日期，或管理銷售階段以及其他詳細數據。

必要條件

  • 推薦 API 驗證中所述 的認證。 此案例支援使用應用程式加上使用者的認證來進行驗證。
  • 此 API 目前僅支援合作夥伴必須處於下列其中一個角色的使用者存取權：轉介管理員或推薦使用者。

REST 要求

要求語法

方法 要求 URI
PATCH https://api.partner.microsoft.com/v1.0/engagements/referrals/{ID}

URI 參數

名稱 類型​​ 必要 描述
識別碼 string Yes 潛在客戶或共同銷售商機的唯一標識符

要求標頭

如需詳細資訊，請參閱 合作夥伴 REST 標頭。

要求本文

要求本文遵循 Json Patch 格式。 JSON Patch 文件具有一個「作業」陣列。 每個作業都會識別特定類型的變更。 這類變更的範例包括新增陣列元素或取代屬性值。

重要

API 目前僅支援 replace 和 add 作業。

要求範例

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

注意

如果傳遞 If-Match 標頭，則會用於並行控制。

REST 回應

如果成功，回應本文會包含更新 的潛在客戶或商機。

回應成功和錯誤碼

每個回應都有一個 HTTP 狀態代碼 ，指出成功或失敗和其他偵錯資訊。 使用網路追蹤工具來讀取此程式代碼、錯誤類型和其他參數。

回應範例

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

提示

回應本文取決於 Prefer 標頭。 如果要求中省略標頭值，響應主體會是空的，且 HTTP 狀態代碼為 204。 將 新增 Prefer: return=representation 至標頭，以取得更新的潛在客戶或商機。

範例要求

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

相關內容