Поделиться через

Обновление сведений о потенциальном клиенте или возможности

  • Статья

В этой статье объясняется, как обновить сведения о потенциальных или возможных возможностях, такие как стоимость сделки, оценка даты закрытия или управление этапами продаж среди других сведений.

Необходимые компоненты

  • Учетные данные, как описано в проверке подлинности API рефералов. Этот сценарий поддерживает проверку подлинности с использованием учетных данных приложений и пользователей.
  • Этот API в настоящее время поддерживает только доступ пользователей, где партнеры должны находиться в одной из следующих ролей: администратор рефералов или пользователь-реферал.

Запрос REST

Синтаксис запроса

Способ URI запроса
PATCH https://api.partner.microsoft.com/v1.0/engagements/referrals/{ID}

Параметр универсального кода ресурса

Имя. Type Обязательно Описание
Идентификатор string Да Уникальный идентификатор для возможности совместного продажи или свинца

Заголовки запросов

Дополнительные сведения см. в заголовках REST партнера.

Текст запроса

Текст запроса следует формату исправления JSON. Документ 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. Обновляет состояние свинца или возможности для 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"}
]

    Внимание

    substatus Поля status должны соответствовать допустимому набору значений перехода.

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

Связанный контент