Remover registros do Radar RJ

DELETE

/v2/radar-rj/records

Remove registros salvos do Radar RJ. Os ids vão no corpo da requisição, em JSON, no campo idsToDelete, e são os _id dos registros devolvidos pela listagem de registros e pelo cadastro. A resposta é 200 mesmo quando algum id não existe: deletedIds traz os ids removidos e message traz "Informações excluídas com sucesso." quando todos foram removidos, ou uma mensagem por id não encontrado ("Não foi possível encontrar o registro com id ."); nesse caso a mensagem de sucesso não aparece, mesmo que outros ids tenham sido removidos. idsToDelete ausente ou que não seja uma lista devolve 500. Requer autenticação via Bearer JWT ou header x-api-key e que a empresa do usuário tenha assinatura do módulo Radar RJ cuja data de validade ainda não chegou; sem isso, 403 (O acesso ao módulo Radar RJ não está liberado.).

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200

application/json

Ids removidos e mensagens

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠403Radar RJ não liberado

Request Example

Shell

JavaScript

Java

Swift

curl --location --request DELETE '/v2/radar-rj/records' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "idsToDelete": [
        "4e1a9c70-2d85-4b63-b9f4-6a0c8e3d5f17"
    ]
}'

Response Example

200 - Sucesso

{
    "message": [
        "Informações excluídas com sucesso."
    ],
    "deletedIds": [
        "4e1a9c70-2d85-4b63-b9f4-6a0c8e3d5f17"
    ]
}

Modificado em 2026-10-13 09:47:06

Página anterior

Cadastrar registros do Radar RJ da empresa

Próxima página

Listar registros do Radar RJ da empresa