Delete todos os registros da Database

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Remove todos os registros existentes em uma Database específica utilizando seu identificador único (id_database).

Este endpoint permite realizar uma limpeza completa dos registros armazenados em uma Database, sendo recomendado para processos de manutenção, reinicialização de bases de dados ou automações que exijam a remoção em massa de registros.

A operação afetará todos os registros da Database informada, independentemente da quantidade de registros existentes.


Importante

🚧

Atenção

Esta operação remove todos os registros da Database selecionada.

Antes de executar a requisição, certifique-se de que a exclusão em massa é realmente necessária, pois a ação poderá impactar integrações, automações, relatórios e demais processos vinculados aos registros removidos.


Parâmetros utilizados

id_database

Identificador único da Database que terá seus registros removidos.

O ID deve ser informado diretamente na rota da requisição.

Exemplo:

DELETE https://api.goalfy.com.br/api/databases/deleteAllRegisters/12345

Neste exemplo:

12345

Corresponde ao ID da Database que terá todos os seus registros excluídos.


Exemplo de resposta

{
  "success": true,
  "message": "Todos os registros da Database foram removidos com sucesso."
}

✅

Respostas esperadas

Sucesso 200

Remove todos os registros existentes na Database informada.


❗

Possíveis erros

404 Not Found

Retornado quando a Database informada não existe ou não foi localizada.

401 Unauthorized

Retornado quando o token de autenticação é inválido ou não foi enviado corretamente.

403 Forbidden

Retornado quando o usuário não possui permissão para excluir registros da Database informada.


Observações

🚧

Atenção

Esta operação afeta todos os registros da Database e deve ser utilizada com cautela.

  • O id_database deve corresponder a uma Database válida existente na plataforma.
  • Todos os registros da Database serão processados para exclusão.
  • Dependendo do volume de registros, a operação pode levar alguns instantes para ser concluída.
  • Recomenda-se realizar validações e backups antes de executar exclusões em massa.
  • O retorno da requisição pode variar conforme as permissões do usuário autenticado.

FAQ?

Perguntas frequentes que fazem.
Segue abaixo cards que podem te ajudar a tirar essas dúvidas:

Path Params
string
required
Defaults to {id}
Headers
string
Defaults to "Token YOUR_TOKEN"
Response
200
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here!