Compartilhar via

Atualizar um cliente potencial ou uma oportunidade

  • Artigo

Este artigo explica como atualizar os detalhes do lead ou da oportunidade, como o valor do negócio, a data de fechamento estimada ou gerenciar as etapas de vendas, entre outros detalhes.

Pré-requisitos

  • Credenciais, conforme descrito em Autenticação da API de referências. Este cenário dá suporte à autenticação com credenciais de aplicativo + usuário.
  • No momento, essa API oferece suporte apenas ao acesso do usuário, onde os parceiros devem estar em uma das seguintes funções: Administrador de Referência ou Usuário de Referência.

Solicitação REST

Sintaxe da solicitação

Método URI da solicitação
PATCH https://api.partner.microsoft.com/v1.0/engagements/referrals/{ID}

Parâmetro do URI

Nome Digitar Obrigatória Descrição
ID cadeia de caracteres Sim O identificador exclusivo de uma oportunidade de lead ou venda conjunta

Cabeçalhos da solicitação

Para obter mais informações, consulte Cabeçalhos REST do parceiro.

Corpo da solicitação

O corpo da solicitação segue o formato Json Patch . Um documento de JSON Patch tem uma matriz de operações. Cada operação identifica um tipo específico de alteração. Exemplos dessas alterações incluem a adição de um elemento de matriz ou a substituição de um valor de propriedade.

Importante

Atualmente, a API suporta apenas as replace operações and add .

Exemplo de solicitação

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

Observação

Se o cabeçalho If-Match for passado, ele será usado para controle de simultaneidade.

Resposta REST

Se for bem-sucedido, o corpo da resposta conterá o cliente potencial ou a oportunidade atualizada.

Códigos de êxito e de erro de resposta

Cada resposta vem com um código de status HTTP que indica êxito ou falha e outras informações de depuração. Use uma ferramenta de rastreamento de rede para ler esse código, o tipo de erro e outros parâmetros.

Exemplo de resposta

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

Dica

O corpo da resposta depende do cabeçalho Prefer. Se o valor do cabeçalho for omitido na solicitação, o corpo da resposta estará vazio com um código de status HTTP 204. Adicione Prefer: return=representation ao cabeçalho para obter o lead ou oportunidade atualizado.

Solicitações de exemplo

  1. Atualiza o valor do negócio para a oportunidade para 10000 e atualiza as notas. Não há verificações de simultaneidade devido à ausência do If-Match cabeçalho.

    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. Atualiza o status de um cliente potencial ou oportunidade para Ganho.

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

    Importante

    Os status campos e substatus devem estar em conformidade com o conjunto permitido de valores de transição.

  3. Adiciona um novo membro da sua organização à equipe de liderança ou oportunidade. A resposta contém o lead ou oportunidade atualizado devido à presença do Prefer: return=representation cabeçalho.

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

Conteúdo relacionado