Pessoas

Desarquivar pessoas (em lote)

POST · API de Integração v2

POST/v2/pessoas/desarquivar

Desarquivar pessoas

Reverte o arquivamento: as pessoas voltam a ser ativas e reaparecem nas listagens.

Identidade: o escritório vem da sua chave de API — só os ids vão no corpo.

Best-effort: a resposta separa desarquivados de ignorados.

Processos (opcional): envie { "processos": { "reativarMonitoramento": true, "reabrir": true } }. As opções são independentes: reativarMonitoramento reativa processos vinculados até a capacidade disponível no plano; reabrir reabre todos os processos vinculados que estejam encerrados, inclusive compartilhados. Processos acima do limite ou já no estado desejado retornam no relatório.

Autenticação

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

Corpo da requisiçãoobrigatório

IDs das pessoas a desarquivar.

application/json

idsinteger[]obrigatório

IDs das pessoas a desarquivar (1..1000).

exemplo: [123,124,125]
processosProcessosDesarquivamentoRequest
Ver propriedades
reabrirboolean

Reabre processos vinculados que estiverem encerrados.

exemplo: false
reativarMonitoramentoboolean

Reativa o monitoramento dos processos vinculados, respeitando o limite do plano.

exemplo: false

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
{
  "desarquivados": [
    123,
    124
  ],
  "ignorados": [
    {
      "id": 125,
      "motivo": "string"
    }
  ],
  "processos": {
    "monitoramentoIgnorado": [
      {
        "motivo": "string",
        "numeroProcesso": "1011214-58.2024.8.26.0477",
        "processoId": 26540878
      }
    ],
    "monitoramentoReativado": [
      {
        "numeroProcesso": "1011214-58.2024.8.26.0477",
        "processoId": 26540878
      }
    ],
    "monitoramentoSolicitado": true,
    "processosReabertos": [
      {
        "numeroProcesso": "1011214-58.2024.8.26.0477",
        "processoId": 26540878
      }
    ],
    "reaberturaIgnorado": [
      {
        "motivo": "string",
        "numeroProcesso": "1011214-58.2024.8.26.0477",
        "processoId": 26540878
      }
    ],
    "reaberturaSolicitada": true
  },
  "solicitados": 3
}

Contrato de respostas

200Lote processado (ver desarquivados/ignorados).

Lote processado (ver desarquivados/ignorados).

application/json

desarquivadosinteger[]

IDs das pessoas desarquivadas

exemplo: [123,124]
ignoradosPessoaIgnoradaResponse[]

Pessoas não processadas e seus motivos

Ver propriedades
idinteger

ID da pessoa não processada

formato: int64exemplo: 125
motivostring

Motivo seguro pelo qual a pessoa foi ignorada

processosProcessosDesarquivamentoResponse
Ver propriedades
monitoramentoIgnoradoProcessoMonitoramentoIgnoradoResponse[]

Processos cujo monitoramento não foi reativado

Ver propriedades
motivostring

Motivo pelo qual o monitoramento não foi alterado

numeroProcessostring

Número do processo

exemplo: 1011214-58.2024.8.26.0477
processoIdinteger

ID interno do processo

formato: int64exemplo: 26540878
monitoramentoReativadoProcessoResumoResponse[]

Processos com monitoramento reativado

Ver propriedades
numeroProcessostring

Número do processo

exemplo: 1011214-58.2024.8.26.0477
processoIdinteger

ID interno do processo

formato: int64exemplo: 26540878
monitoramentoSolicitadoboolean

Indica se foi solicitada a reativação de monitoramento

exemplo: true
processosReabertosProcessoResumoResponse[]

Processos reabertos

Ver propriedades
numeroProcessostring

Número do processo

exemplo: 1011214-58.2024.8.26.0477
processoIdinteger

ID interno do processo

formato: int64exemplo: 26540878
reaberturaIgnoradoProcessoEncerramentoIgnoradoResponse[]

Processos cuja reabertura não foi aplicada

Ver propriedades
motivostring

Motivo pelo qual o encerramento ou a reabertura não foi aplicado

numeroProcessostring

Número do processo

exemplo: 1011214-58.2024.8.26.0477
processoIdinteger

ID interno do processo

formato: int64exemplo: 26540878
reaberturaSolicitadaboolean

Indica se foi solicitada a reabertura

exemplo: true
solicitadosinteger

Quantidade de pessoas solicitadas

formato: int32exemplo: 3
400Payload inválido (lista vazia, mais de 1000 ids, nulo ou não positivo).

Payload inválido (lista vazia, mais de 1000 ids, nulo ou não positivo).

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

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.