Deletar em Lote

Através desse endpoint, vamos deletar alguns contratos em lote.

PATCH /contracts

Clique aqui para testar endpoint

🚧

Todos os endpoints deverão ser autenticados

headers = {
  'Authorization': f'Bearer {api_key}',
  'Content-Type': 'application/json'
}

Exemplo de payload:

{
    "contract_ids":
        [
            "176022",
            "175989"
        ],
        "deleted": true
}

Descrição do payload:

NameTypeDescription
contract_idsarray de stringsarray contendo os ids dos contratos que deverão ser deletados em lote.
deletedbooleanrecebe o valor de true para deletar os documentos.

Exemplo de resposta:

{
    "data": {
        "errors": [],
        "not_found": [],
        "success": 2
    }
}

Deletar Permanentemente

A ação acima documentada, move o contrato para a lixeira, onde ainda é possível restaurar os contratos novamente. Contudo, após mover para a lixeira, caso queira deletar permanentemente o documento, consuma o endpoint abaixo.

DELETE /contracts

Testar endpoint

⚠️ Essa ação irá deletar os contratos de forma permanente, não sendo possível recupera-los.

Exemplo de payload:

{
    "contract_ids":
        [
          "176130",
          "176131"
        ]
}

Descrição do payload:

NameTypeDescription
contract_idsarray de stringsarray contendo os ids dos contratos que deverão ser deletados permanentemente em lote.

Exemplo de resposta:

{
    "data": {
        "errors": [],
        "not_found": [],
        "success": 2
    }
}

Como utilizar ações em lote na Contraktor?

Acesse nossa central de ajuda e veja o passo a passo completo:

Realizando ações em massa e assinaturas em lote