APIs privadas

Reuniões · criar e agir

Criar motivos, manter reuniões e executar ações operacionais

View as Markdown

Reuniões · criar e agir

Esta página concentra as operações privadas de escrita para motivos de reunião, motivos de cancelamento e reuniões.

Escopo atual:

  • POST /simplificav2/reuniao_motivo
  • PUT /simplificav2/reuniao_motivo/{id}
  • POST /simplificav2/reuniao_motivo_cancelamento
  • PUT /simplificav2/reuniao_motivo_cancelamento/{id}
  • POST /simplificav2/reuniao
  • PUT /simplificav2/reuniao/{id}
  • POST /simplificav2/reuniao/{id}/remarcar
  • POST /simplificav2/reuniao/{id}/cancelar
  • POST /simplificav2/reuniao/{id}/finalizar
  • POST /simplificav2/reuniao/{id}/oportunidade

Como acessar

1Authorization: Bearer {{bearer_token}}
2Content-Type: application/json

Regras gerais

  • todas as chamadas usam JSON;
  • cada chamada opera em um único registro;
  • os cadastros criados por POST nascem ativos;
  • os PUT atualizam somente os atributos enviados;
  • campos omitidos continuam com o valor atual e não são apagados;
  • não existe exclusão por API para esses cadastros auxiliares;
  • reuniões mudam de estado por rotas explícitas, não por exclusão.

Motivos de reunião

Rotas

  • GET /simplificav2/reuniao_motivo
  • POST /simplificav2/reuniao_motivo
  • PUT /simplificav2/reuniao_motivo/{id}

Observações:

  • o cadastro nasce ativo;
  • ic_encerra_negociacao aceita S ou N;
  • esse campo indica se, nas telas do sistema, a finalização da reunião direciona o usuário para o fluxo de abertura de negociação;
  • duracao_padrao é tratada em minutos e ajuda a sugerir a duração da reunião;
  • duracao_padrao não pode ser negativa;
  • ativo só aparece na atualização.

Motivos de cancelamento

Rotas

  • GET /simplificav2/reuniao_motivo_cancelamento
  • POST /simplificav2/reuniao_motivo_cancelamento
  • PUT /simplificav2/reuniao_motivo_cancelamento/{id}

Observações:

  • o cadastro nasce ativo;
  • a origem interna continua fixa para reunião;
  • ativo só aparece na atualização.

Reuniões

Rotas

  • GET /simplificav2/reuniao
  • POST /simplificav2/reuniao
  • PUT /simplificav2/reuniao/{id}
  • POST /simplificav2/reuniao/{id}/remarcar
  • POST /simplificav2/reuniao/{id}/cancelar
  • POST /simplificav2/reuniao/{id}/finalizar

Regras principais:

  • a criação exige pessoa, consultores, data, hora inicial, descrição, motivo e tipo da reunião;
  • presencial_online aceita P ou O;
  • link_reuniao, quando enviado, precisa ter formato válido;
  • a criação e a remarcação respeitam as validações de conflito de agenda já usadas no sistema;
  • a atualização altera somente os campos editáveis da reunião;
  • cancelamento, finalização e remarcação seguem a lógica operacional já existente do domínio;
  • a finalização por API não cria negociação automaticamente;
  • existe uma rota específica para vincular a reunião a uma oportunidade já existente.

Resposta de sucesso

Todas as operações usam o mesmo retorno mínimo:

1{
2  "status": "sucesso",
3  "mensagem": "Solicitação executada com sucesso.",
4  "data": {
5    "id": 123
6  }
7}