Agenda

Criar atividade na agenda

POST · API de Integração v2

POST/v2/agenda

Criar atividade na agenda

Cria uma atividade (compromisso ou prazo) na agenda do seu escritório.

Identidade: o escritório e o usuário criador são resolvidos automaticamente a partir da sua chave de API — não vão no corpo.

Obrigatórios: apenas titulo, tipoEventoId e periodo. Todo o resto é opcional.

IDs de vínculo (tipo de evento, responsáveis, equipes, processo, pessoa, checklists) são obtidos antes nas rotas /v2/{recurso}/opcoes.

Recursos automáticos:

Recorrência — informe recorrencia e a atividade é replicada em N ocorrências.
Revisores e checklists — podem ser herdados do tipo de evento / fluxo, somados aos informados manualmente.
Herdar do processo — com um processoId, use herdarDoProcesso para copiar as equipes/responsáveis já vinculados ao processo, sem re-listar.

CAMPOS DO CORPO — CriarAgendaRequest
Campo	Validação	Descrição	Exemplo	Regras
titulo	@NotBlank	Título/assunto da atividade, exibido na agenda.	Contestação - Processo X	Obrigatório; não pode ser vazio.
tipoEventoId	@NotNull	Tipo do compromisso (ex.: Audiência, Prazo, Reunião). Id de `/v2/tipos-evento/opcoes`.	12	Obrigatório.
prioridade	enum	Prioridade para destaque visual na agenda.	MEDIA	Opcional. Um de: SEM_PRIORIDADE, BAIXA, MEDIA, ALTA (default SEM_PRIORIDADE).
periodo	@NotNull @Valid	Datas e horas do prazo (ver tabela periodo abaixo).	{ objeto }	Obrigatório.
observacao	-	Texto livre com detalhes adicionais.	Prazo em dobro (Fazenda Pública).	Opcional.
responsaveisIds	-	Usuários responsáveis por executar a atividade. Ids de `/v2/usuarios/opcoes`.	[10, 11]	Opcional.
equipesIds	-	Equipes responsáveis (todos os membros passam a acompanhar). Ids de `/v2/equipes/opcoes`.	[5]	Opcional.
processoId	-	Processo judicial ao qual a atividade se refere. Id de `/v2/processos/opcoes`.	999	Opcional.
pessoasIds	@Size(max 1)	Cliente(s)/pessoa(s) vinculada(s). Ids de `/v2/pessoas/opcoes`.	[123]	Opcional. Array por compatibilidade futura; hoje aceita no máximo 1 (mais de um → 400).
herdarDoProcesso	@Valid	Copia para a atividade as equipes e/ou responsáveis já vinculados ao processo (ver tabela herdarDoProcesso).	{ objeto }	Opcional. Exige processoId. É somado (união, sem duplicar) ao que vier em responsaveisIds/equipesIds.
documentos	@Valid	Links de documentos no SharePoint (ver tabela documentos).	[ {...} ]	Opcional. Só a URL, sem upload de arquivo.
revisores	@Valid	Revisores adicionais informados manualmente (`{ manualIds: [...] }`).	{ "manualIds": [20] }	Opcional. Revisores por tipo/fluxo já entram automaticamente.
recorrencia	@Valid	Repete a atividade em várias ocorrências (ver tabela recorrencia).	{ objeto }	Opcional.
checklistTemplateIds	-	Modelos de checklist a clonar na atividade. Ids de `/v2/checklists/opcoes`.	[7, 9]	Opcional.
concluido	-	Cria a atividade já concluída.	false	Opcional (default false). Grava só a flag — não dispara efeitos de conclusão (revisão/notificação); a `situacao` segue "pendente".

periodo — objeto obrigatório
Campo	Validação	Descrição	Exemplo	Regras
inicio	@NotNull	Data de início da atividade/prazo.	2026-07-10	Obrigatório.
fim	-	Data de fim.	2026-07-12	Opcional. Se omitida, assume `inicio`.
horaInicio	-	Hora de início.	09:00	Opcional.
horaFim	-	Hora de fim.	10:00	Opcional.

recorrencia — objeto opcional
Campo	Validação	Descrição	Exemplo	Regras
tipo	@NotNull	Frequência da repetição.	MENSAL	Obrigatório. Um de: SEMANAL, MENSAL.
quantidade	@NotNull @Min(1) @Max(200)	Número de ocorrências geradas.	3	Obrigatório. Entre 1 e 200.

documentos[] — opcional
Campo	Validação	Descrição	Exemplo	Regras
url	@NotBlank	URL do documento no SharePoint.	https://sharepoint.com/...	Obrigatório.
rotulo	-	Rótulo exibido para o link.	Petição inicial	Opcional.

herdarDoProcesso — objeto opcional (exige processoId)
Campo	Validação	Descrição	Exemplo	Regras
equipes	-	Copia as equipes já vinculadas ao processo para a atividade.	true	Opcional (default false). Une com equipesIds; duplicatas ignoradas.
responsaveis	-	Copia os responsáveis já vinculados ao processo para a atividade.	true	Opcional (default false). Une com responsaveisIds; duplicatas ignoradas.

Autenticação

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

Corpo da requisiçãoobrigatório

Dados da atividade a criar (ver tabela de campos na descrição).

application/json

audienciaIdinteger

Audiência vinculada

formato: int64exemplo: 789

checklistTemplateIdsinteger[]

IDs de templates de checklist a clonar

concluidoboolean

Criar já concluída (default false; grava só a flag)

exemplo: false

dataFatalstring

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

exemplo: 2026-07-12

documentosDocumentoRequest[]

Links de documentos (SharePoint)

Ver propriedades

rotulostring

Rótulo exibido

exemplo: Petição inicial

urlstringobrigatório

URL do documento

exemplo: https://sharepoint.com/...

equipesIdsinteger[]

IDs das equipes

expedienteIdinteger

Expediente vinculado

formato: int64exemplo: 456

herdarDoProcessoHerdarDoProcessoRequest

Ver propriedades

equipesboolean

Copia as equipes vinculadas ao processo

exemplo: true

responsaveisboolean

Copia os responsáveis vinculados ao processo

exemplo: true

localstring

Local do compromisso

exemplo: Sala de reuniões 2

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

pessoasIdsinteger[]

Pessoa(s) vinculada(s). Array por compatibilidade futura; hoje aceita no máximo 1. Ids de /v2/pessoas/opcoes.

exemplo: [123]

prioridadestring

Prioridade (default SEM_PRIORIDADE)

valores: ALTA · BAIXA · MEDIA · SEM_PRIORIDADEexemplo: MEDIA

privadaboolean

Restringe a visualização aos responsáveis

exemplo: true

processoIdinteger

Processo vinculado

formato: int64exemplo: 999

publicacaoIdstring

Identificador MongoDB da publicação vinculada

exemplo: 665f1a2b9c8d7e6f5a4b3c2d

recorrenciaRecorrenciaRequest

Ver propriedades

quantidadeintegerobrigatório

Quantidade de ocorrências (1..200)

formato: int32mín.: 1máx.: 200exemplo: 3

tipostringobrigatório

Tipo de recorrência

valores: MENSAL · SEMANALexemplo: MENSAL

responsaveisIdsinteger[]

IDs dos responsáveis

revisoresRevisoresRequest

Ver propriedades

manualIdsinteger[]

IDs de revisores manuais

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

Tipo do compromisso (ex.: Audiência, Prazo, Reunião). Id de /v2/tipos-evento/opcoes

formato: int64exemplo: 12

titulostringobrigatório

Título da atividade

exemplo: Contestação - Processo X

Respostas4

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 declarado no OpenAPI · application/json

Exemplo · HTTP 200

{
  "id": 863210,
  "titulo": "Contestação - Processo X",
  "tipoEventoId": 12,
  "prioridade": "MEDIA",
  "responsaveisIds": [
    10,
    11
  ],
  "equipesIds": [
    5
  ],
  "processoId": 999,
  "pessoasIds": [
    123
  ],
  "revisores": [
    {
      "userId": 20,
      "tipo": "MANUAL"
    }
  ],
  "documentos": [
    {
      "url": "https://sharepoint.com/...",
      "rotulo": "Petição inicial"
    }
  ],
  "atividadesGeradas": [],
  "ocorrencias": [],
  "checklists": []
}

Contrato de respostas

200Atividade criada.

Atividade criada.

application/json

atividadesGeradasAtividadeGeradaResponse[]

Ver propriedades

checklistsChecklistResponse[]

Ver propriedades do item

nomestring

templateIdinteger

formato: int64

totalItensinteger

formato: int32

dataFatalstring

exemplo: yyyy-MM-dd

equipesIdsinteger[]

fimstring

exemplo: yyyy-MM-dd

fluxoIdinteger

formato: int64

idinteger

formato: int64

iniciostring

exemplo: yyyy-MM-dd

prioridadestring

responsaveisIdsinteger[]

revisoresRevisorResponse[]

Ver propriedades do item

tipostring

userIdinteger

formato: int64

tipoEventoIdinteger

formato: int64

titulostring

audienciaIdinteger

formato: int64

checklistsChecklistResponse[]

Ver propriedades

nomestring

templateIdinteger

formato: int64

totalItensinteger

formato: int32

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

ocorrenciasOcorrenciaResponse[]

Ver propriedades

atividadePrincipalIdinteger

formato: int64

dataFatalstring

exemplo: yyyy-MM-dd

equipesIdsinteger[]

fimstring

exemplo: yyyy-MM-dd

idinteger

formato: int64

iniciostring

exemplo: yyyy-MM-dd

prioridadestring

responsaveisIdsinteger[]

tipoEventoIdinteger

formato: int64

titulostring

pessoasIdsinteger[]

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 no contrato Problem Details.

Payload inválido 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.

500Erro interno no contrato Problem Details.

Erro interno 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

curl --request POST \
  --url 'https://api.expedit.com.br/v2/agenda' \
  --header 'Accept: application/json' \
  --header 'X-API-Key: SUA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "periodo": {}
}'

Requisição e resposta

As chamadas são enviadas diretamente à API. O domínio deste portal precisa estar autorizado no CORS.

Ver JSON gerado

Corpo gerado dos campos

{
  "periodo": {}
}

A resposta aparecerá aquiPreencha os campos e envie a requisição para consultar o retorno da API.

Explorar exemplos de resposta

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 declarado no OpenAPI · application/json

Exemplo · HTTP 200

{
  "id": 863210,
  "titulo": "Contestação - Processo X",
  "tipoEventoId": 12,
  "prioridade": "MEDIA",
  "responsaveisIds": [
    10,
    11
  ],
  "equipesIds": [
    5
  ],
  "processoId": 999,
  "pessoasIds": [
    123
  ],
  "revisores": [
    {
      "userId": 20,
      "tipo": "MANUAL"
    }
  ],
  "documentos": [
    {
      "url": "https://sharepoint.com/...",
      "rotulo": "Petição inicial"
    }
  ],
  "atividadesGeradas": [],
  "ocorrencias": [],
  "checklists": []
}

Exemplos e campos gerados do contrato OpenAPI. Revise os valores antes de integrar.