Skip to navigation

Overview

Atividades são os compromissos da agenda — ligação, reunião, visita, tarefa — sempre vinculados a uma oportunidade. Cada atividade tem um tipo, data e hora, duração e um estado próprio: open (aberta), late (atrasada) ou done (concluída).

Rotas

MétodoRotaPara quê
GET/activitiesListar atividades de um período, por responsável, estado e tipo.
POST/activitiesCriar atividade numa oportunidade.
PATCH/activities/statusAlterar status da atividade, em uma ou várias.
PATCH/activities/dateReagendar atividade, em uma ou várias.
PATCH/activities/stageMover atividade de etapa (módulo Gestão de Atividades).
GET/activities/typesListar tipos de atividade.

Fluxo típico

  1. Consulte os tipos em GET /activities/types e guarde o id do tipo desejado.
  2. Crie com POST /activities, informando budget (ID da oportunidade), activity (ID do tipo) e date (YYYY-MM-DD HH:mm:ss).
  3. Leia a agenda com GET /activities, usando start e end, para obter o ID da atividade criada.
  4. Conclua com PATCH /activities/status (status: "done") ou mude a data com PATCH /activities/date.

Cuidados

  • A criação não devolve o ID da atividade. A resposta identifica a oportunidade; o ID sai da listagem da agenda.
  • Atividade nasce com o usuário do token como responsável.
  • Operações em lote. As rotas PATCH recebem ids como lista ([301,302]) ou texto ("301,302"), nunca vazio.
  • Reagendamento tem limites. Atividade concluída ou bloqueada não pode ser reagendada; a resposta é 400 com ACTIVITY_MUTATION_FAILED.
  • Etapa da atividade ≠ etapa do funil. PATCH /activities/stage usa o fluxo de atividades da conta e exige o módulo Gestão de Atividades ativo.
  • Filtro padrão da agenda. Sem responsible, a listagem traz só as atividades do usuário autenticado; sem status, traz open, late e done.