Remover monitoramento em lote
Este endpoint permite interromper o monitoramento de vários processos cadastrados de uma só vez.
Após a exclusão, os monitoramentos deixarão de ser consultados periodicamente e nenhum novo callback será enviado.
Requisição
DELETE https://api.push.codilo.com.br/v1/processo/excluir/lote
Parâmetros
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| deleteAll | boolean | Sim | Define o comportamento da exclusão. - true: remove todos os monitoramentos vinculados à credencial do access token. Neste caso, cnjIds não deve ser enviado.- false: remove apenas os monitoramentos informados em cnjIds. Neste caso, cnjIds torna-se obrigatório. |
| cnjIds | array | Condicional | Lista de IDs dos monitoramentos que serão removidos. Obrigatório quando deleteAll = false. |
Exemplos de Requisição
- cURL
- Python
- PHP
- Node.js
curl --request DELETE \
--url https://api.push.codilo.com.br/v1/processo/excluir/lote \
--header 'Authorization: Bearer SEU_ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"cnjIds": ["460477ff-9083-4b3d-ba1c-b6cc5efd1111","51dbaff6-ed4e-4181-a757-660e50639999"]
}'
import requests
headers = {
"Authorization": "Bearer SEU_ACCESS_TOKEN",
"Content-Type": "application/json",
}
payload = {
"cnjIds": ["460477ff-9083-4b3d-ba1c-b6cc5efd1111","51dbaff6-ed4e-4181-a757-660e50639999"],
}
response = requests.delete(
"https://api.push.codilo.com.br/v1/processo/excluir/lote",
headers=headers,
json=payload
)
print(response.json())
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.push.codilo.com.br/v1/processo/excluir/lote');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer SEU_ACCESS_TOKEN',
'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
"cnjIds" => ["460477ff-9083-4b3d-ba1c-b6cc5efd1111","51dbaff6-ed4e-4181-a757-660e50639999"],
]));
$response = curl_exec($ch);
curl_close($ch);
echo $response;
fetch("https://api.push.codilo.com.br/v1/processo/excluir/lote", {
method: "DELETE",
headers: {
Authorization: "Bearer SEU_ACCESS_TOKEN",
"Content-Type": "application/json",
},
body: JSON.stringify({
cnjIds: ["460477ff-9083-4b3d-ba1c-b6cc5efd1111","51dbaff6-ed4e-4181-a757-660e50639999"],
}),
});
Exemplo de Resposta (200 - OK)
- Sucesso
{
"success": true
}
Status Codes
| Status | Significado | Descrição |
|---|---|---|
| 200 | OK | Processo removido com sucesso |
| 401 | Unauthorized | Token inválido ou não informado |
| 403 | Forbidden | Processo não pode ser removido (ex.: período mínimo de 1 mês ainda não concluído) |