Agenda

Atualizar atividade.

PUT · API de Integração v2

PUT/v2/agenda/{id}

Substitui cabeçalho, responsáveis/equipes (full-replace) e sincroniza revisor/checklist por diff. O tipo de tarefa pode mudar, mas não recria fluxo nem recorrências existentes. Quando um campo operacional do contrato externo mudar, produz o webhook agenda.compromisso.atualizado para endpoints inscritos.

Autenticação

X-API-Key no cabeçalho. Como autenticar

Parâmetros de caminho1

idintegerobrigatório

ID da atividade de agenda.

Corpo da requisiçãoobrigatório

request

application/json

audienciaIdinteger

Audiência vinculada

formato: int64
checklistTemplateIdsinteger[]

IDs de templates de checklist (substitui integralmente)

concluidoboolean

Concluída (default false)

dataFatalstring

Data fatal do compromisso (default = fim do período)

equipesIdsinteger[]

IDs das equipes (substitui integralmente)

escopoRecorrenciastring

OCORRENCIA, FUTURAS ou SERIE ao editar recorrência

valores: FUTURAS · OCORRENCIA · SERIE
expedienteIdinteger

Expediente vinculado

formato: int64
localstring

Local do compromisso

observacaostring

Observação livre

periodoPeriodoRequestobrigatório
Ver propriedades
fimstring

Data de fim (default = início)

exemplo: 2026-07-12
horaFimstring

Hora de fim

exemplo: 10:00
horaIniciostring

Hora de início

exemplo: 09:00
iniciostringobrigatório

Data de início

exemplo: 2026-07-10
pessoaIdinteger

Pessoa vinculada (id único)

formato: int64
prioridadestring

Prioridade (default SEM_PRIORIDADE)

valores: ALTA · BAIXA · MEDIA · SEM_PRIORIDADE
privadaboolean

Restringe a visualização aos responsáveis

processoIdinteger

Processo vinculado

formato: int64
publicacaoIdstring

Publicação de origem imutável: omitir/vazio preserva; se informado, deve coincidir com o vínculo existente

responsaveisIdsinteger[]

IDs dos responsáveis (substitui integralmente)

revisorManualIdsinteger[]

IDs de revisores manuais (substitui integralmente)

serieRecorrenteSerieRecorrenteRequest
Ver propriedades
dataFinalstring

Obrigatória quando termino=DATA_FINAL

exemplo: 2027-12-31
frequenciasstring[]obrigatório

Uma frequência da série: SEMANAL ou MENSAL

exemplo: ["SEMANAL"]
terminostringobrigatório

INDEFINIDO ou DATA_FINAL

valores: DATA_FINAL · INDEFINIDOexemplo: DATA_FINAL
tipoEventoIdintegerobrigatório

Novo tipo do compromisso

formato: int64
titulostringobrigatório

Título da atividade

Respostas3

Exemplos ilustrativos · nenhuma requisição é enviada

200 · Sucesso

Quando acontece
A operação foi concluída.
Como tratar
Leia os dados retornados; em listagens, confira também a paginação.

Exemplo ilustrativo gerado do schema · application/json

Exemplo · HTTP 200
{
  "audienciaId": 1,
  "concluido": false,
  "cor": "string",
  "dataFatal": "yyyy-MM-dd",
  "diaTodo": false,
  "documentos": [
    {
      "rotulo": "string",
      "url": "string"
    }
  ],
  "equipesIds": [
    1
  ],
  "expedienteId": 1,
  "fim": "yyyy-MM-dd",
  "id": 1,
  "inicio": "yyyy-MM-dd",
  "local": "string",
  "observacao": "string",
  "pessoaId": 1,
  "prioridade": "string",
  "privada": false,
  "processoId": 1,
  "publicacaoId": "string",
  "recorrencia": {
    "quantidade": 1,
    "tipo": "string"
  },
  "responsaveisIds": [
    1
  ],
  "revisores": [
    {
      "tipo": "string",
      "userId": 1
    }
  ],
  "tipoAlerta": "string",
  "tipoEventoId": 1,
  "titulo": "string"
}

Contrato de respostas

200Atividade atualizada.

Atividade atualizada.

application/json

audienciaIdinteger
formato: int64
concluidoboolean
corstring
dataFatalstring
exemplo: yyyy-MM-dd
diaTodoboolean
documentosDocumentoResponse[]
Ver propriedades
rotulostring
urlstring
equipesIdsinteger[]
expedienteIdinteger
formato: int64
fimstring
exemplo: yyyy-MM-dd
idinteger
formato: int64
iniciostring
exemplo: yyyy-MM-dd
localstring
observacaostring
pessoaIdinteger
formato: int64
prioridadestring
privadaboolean
processoIdinteger
formato: int64
publicacaoIdstring
recorrenciaRecorrenciaResponse
Ver propriedades
quantidadeinteger
formato: int32
tipostring
responsaveisIdsinteger[]
revisoresRevisorResponse[]
Ver propriedades
tipostring
userIdinteger
formato: int64
tipoAlertastring
tipoEventoIdinteger
formato: int64
titulostring
400Payload inválido ou atividade não encontrada, no contrato Problem Details.

Payload inválido ou atividade não encontrada, no contrato Problem Details.

application/json

codestring
exemplo: validation_error
correlationIdstring
exemplo: c4ce7307-1917-4539-b17a-9c73c972c261
detailstring
exemplo: Existem campos inválidos na requisição.
errorsErroItemApiResponse[]
Ver propriedades
codestring

Código estável do erro

exemplo: field_validation_error
fieldstring

Campo relacionado

exemplo: agenda.titulo
messagestring

Mensagem segura

exemplo: não deve estar em branco
instancestring
exemplo: /v2/agenda
requestIdstring
exemplo: e9db6635-7db3-40cb-8dd2-453c25e6a461
statusinteger
formato: int32exemplo: 400
titlestring
exemplo: Erro de validação
typestring
formato: uriexemplo: /errors/validation-error
401Não autenticado (token ausente/inválido).

Não autenticado (token ausente/inválido).

O contrato não declara um corpo para esta resposta.

© 2026 Expedit LawtechFeito para conectar.