Actualización de un cliente potencial o una oportunidad

Artículo
01/18/2024

En este artículo se explica cómo actualizar los detalles del cliente potencial o de la oportunidad, como el valor de la oferta, la fecha de cierre estimada o administrar las fases de ventas entre otros detalles.

Requisitos previos

Credenciales tal como se describe en el artículo Autenticación de la API de partners. Este escenario admite la autenticación con credenciales de aplicación y usuario.
Actualmente, esta API solo admite el acceso de usuario en el que los asociados deben estar en uno de los siguientes roles: global Administración, referencia Administración o usuario de referencia.

Solicitud REST

Sintaxis de la solicitud

Método	URI de solicitud
PATCH	`https://api.partner.microsoft.com/v1.0/engagements/referrals/{ID}`

Parámetro de URI

Nombre	Type	Obligatorio	Descripción
ID	string	Sí	Identificador único de una oportunidad de venta conjunta o de cliente potencial

Encabezados de solicitud

Consulte Encabezados REST de partners para obtener más información.

Cuerpo de la solicitud

El cuerpo de la solicitud sigue el formato de revisión json. Un documento JSON Patch tiene una matriz de operaciones. Cada operación identifica un tipo determinado de cambio. Algunos ejemplos de estos cambios incluyen agregar un elemento de matriz o reemplazar un valor de propiedad.

Importante

Actualmente, la API solo admite las replace operaciones y add .

Ejemplo de solicitud

PATCH https://api.partner.microsoft.com/v1.0/engagements/referrals/{ID}
Authorization: Bearer <token>
Content-Type: application/json
Prefer: return=representation

[
    {
        "op": "replace",
        "path": "/details/dealValue",
        "value": "10000"
    },
    {
        "op": "add",
        "path": "/team/-",
        "value": {
            "email": "jane.doe@contoso.com",
            "firstName": "Jane",
            "lastName": "Doe",
            "phoneNumber": "0000000001"
        }
    }
]

Nota:

Si se pasa el encabezado If-Match , se usará para el control de simultaneidad.

Respuesta REST

Si se ejecuta correctamente, el cuerpo de la respuesta contiene el cliente potencial o la oportunidad actualizados.

Códigos de error y de respuesta correctos

Cada respuesta incluye un código de estado HTTP que indica si la operación se ha realizado correctamente o con errores y proporciona información de depuración adicional. Use una herramienta de seguimiento de red para leer este código, el tipo de error y los parámetros adicionales.

Ejemplo de respuesta

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

Sugerencia

El cuerpo de la respuesta depende del encabezado Prefer . Si el valor del encabezado se omite en la solicitud, el cuerpo de la respuesta está vacío con un código de estado HTTP 204. Agregue Prefer: return=representation al encabezado para obtener el cliente potencial o la oportunidad actualizados.

Solicitudes de ejemplo

Novedades el valor de la oferta para la oportunidad de 10000 y actualiza las notas. No hay comprobaciones de simultaneidad debido a la ausencia del If-Match encabezado.

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

Novedades el estado de un cliente potencial o oportunidad de Ganar.

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