通过

更新潜在客户或商机

  • 项目

本文介绍如何更新潜在顾客或商机详细信息，例如交易价值、估计的收盘日期或管理销售阶段以及其他详细信息。

先决条件

  • 引荐 API 身份验证中所述的凭据。 此方案支持使用应用凭据和用户凭据进行身份验证。
  • 此 API 目前仅支持合作伙伴必须处于以下角色之一的用户访问权限：引荐管理员或引荐用户。

REST 请求

请求语法

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

URI 参数

名称 类型​​ 必需 描述
ID string 是 潜在顾客或联合销售机会的唯一标识符

请求标头

有关详细信息，请参阅 合作伙伴 REST 标头。

请求正文

请求正文遵循 Json 修补程序 格式。 JSON 修补程序文档有一个操作数组。 每个操作都标识一种特定类型的更改。 此类更改的示例包括添加数组元素或替换属性值。

重要

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

    重要

    和statussubstatus字段应符合允许的转换值集。

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

相关内容