Resolver as dependências primeiro

  1. 1

    Liste pipelines e selecione o pipelineId do ambiente atual.

  2. 2

    Liste as etapas filtrando pelo pipeline e confirme o stageId correto.

  3. 3

    Liste usuários e confirme o responsibleId de uma pessoa ativa.

  4. 4

    Prepare um contato fictício ou autorizado para o teste.

  5. 5

    Registre os IDs sem expor telefone ou e-mail completos.

Tela de APIs com acesso à documentação interativa
Obtenha todas as dependências por consulta antes de criar a oportunidade.

Usar as rotas de oportunidades

  • Listar: GET /v2/api/external/{ApiID}/listOpportunities com page, limit, status e pipelineId.
  • Criar: POST .../createOpportunity com dados do contato e da oportunidade, incluindo name, value, status, pipelineId, stageId, responsibleId, closingForecast e description.
  • Atualizar: POST .../updateOpportunity com opportunityId e os campos comerciais publicados.
  • Excluir: POST .../deleteOpportunity com opportunityId.

Criar e conferir uma oportunidade

  1. 1

    Confirme que stageId pertence ao pipelineId selecionado.

  2. 2

    Abra createOpportunity no sandbox e use um contato de teste.

  3. 3

    Preencha somente os campos necessários e execute uma única requisição.

  4. 4

    Liste as oportunidades filtrando pelo pipeline.

  5. 5

    Confira nome, etapa, responsável, valor e status na resposta e no Kanban.

  6. 6

    Guarde o identificador retornado pela versão antes de permitir atualizações.

Dashboard do Funil de Vendas com indicadores de oportunidades
A conferência no funil mostra se a oportunidade entrou na estrutura e nos indicadores esperados.

Validar formatos e estados no sandbox

  • status é publicado como string, sem enumeração de valores, idioma ou capitalização aceitos.
  • closingForecast é uma string sem formato de data publicado.
  • value é numérico, mas moeda e precisão não são especificadas.
  • Não está explicado se o contato precisa existir ou se será criado ou vinculado por number, contactName e email.
  • updateOpportunity não publica campos para mudar os dados do contato.
  • Não existe externalKey nem outra chave de repetição segura documentada para oportunidades.
Detalhes de gestão do contato com acesso ao funil e às oportunidades
Confirme o vínculo comercial no contato e no funil depois de cada mudança.

Diagnosticar criação, atualização e exclusão

  • Oportunidade não aparece: revise paginação e filtros de pipeline e status.
  • Etapa recusada: confirme que stageId pertence ao pipelineId.
  • Responsável recusado: confira o ID e o estado do usuário.
  • Status ou previsão recusados: valide o valor literal e o formato aceito na documentação interativa.
  • Contato inesperado: revise number, contactName, email e validateNumber.
  • Exclusão incerta: não repita uma operação destrutiva sem confirmar se o registro ainda existe.