Atividades

Leitura e manutenção das atividades da agenda.

🗓️

Sobre esta seção

Reler uma atividade da agenda — ligação, visita, retorno ou lembrete — pelo id, ou listar as atividades com filtro (POST /atividades/search).

Criar, alterar, concluir e cancelar atividade (POST /atividades, PUT /atividades/{id}, complete, cancel).

Escopos: leitura com atividades:read, escrita com atividades:write

Regras que valem para toda a seção:

RegraO que significa
✍️ Escrita por açãoIncluir, alterar, concluir e cancelar, cada um com rota própria e webhook (atividade.incluida, alterada, concluida). A situação muda só por complete e cancel. Sem recorrência pela API.
🔗 Visita manda na atividade delaA atividade criada por uma visita muda pela visita; alterá-la direto responde 409 ACTIVITY_FROM_VISIT. Atividade vinda de agenda externa não se altera pela API (403).
🔎 Busca no mesmo formatoCada item da busca vem no formato do GET /{id}. Filtros no corpo, 20 por página (até 100).
🔔 Complemento do webhookO GET existe para quem recebe um evento poder reler o registro depois: reprocessar uma fila, conferir um dado, subir uma integração do zero.