Pessoas

Excluir pessoas (em lote)

POST · API de Integração v2

POST/v2/pessoas/exclusoes

Excluir pessoas

Exclui uma ou mais pessoas do seu escritório (soft-delete: some das listagens, mas o registro é preservado).

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

Em lote: mande { "ids": [123, 124] }. Excluir uma só é uma lista de 1; máximo de 1000 ids.

Best-effort: a resposta separa excluidos (soft-deletados agora) de ignorados (não encontrados, de outro escritório, ou já excluídos). Um id inválido no meio NÃO derruba os demais.

Autenticação

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

Corpo da requisiçãoobrigatório

IDs das pessoas a excluir.

application/json

idsinteger[]obrigatório

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

exemplo: [123,124,125]

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

Exemplo · HTTP 200

{
  "solicitados": 3,
  "excluidos": [
    123,
    124
  ],
  "ignorados": [
    {
      "id": 999,
      "motivo": "Pessoa não encontrada, já excluída ou fora do cliente autenticado."
    }
  ]
}

Contrato de respostas

200Lote processado (ver excluidos/ignorados).

Lote processado (ver excluidos/ignorados).

application/json

excluidosinteger[]

IDs das pessoas excluídas

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

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.

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

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

{
  "ids": []
}

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

{
  "solicitados": 3,
  "excluidos": [
    123,
    124
  ],
  "ignorados": [
    {
      "id": 999,
      "motivo": "Pessoa não encontrada, já excluída ou fora do cliente autenticado."
    }
  ]
}

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