Skip to content

Excluir tenant

DELETE
/tenants

Exclui permanentemente o tenant (soft delete).

Comportamento

  • O tenant é marcado como excluído (soft delete) e fica inacessível
  • A cobrança é encerrada na próxima competência
  • Se o tenant foi excluído durante o mês corrente, ainda será cobrado
    neste mês (última cobrança)
  • Para apenas bloquear o login sem afetar a cobrança, use PUT /tenants
    com ativo: false

Mensagens de Erro

Mensagem Causa
Tenant not found ID não existe ou não pertence ao cliente

Compatibilidade: Clientes que não suportam o método HTTP DELETE
podem usar POST /tenants/delete com o mesmo payload e comportamento.

Autorizações

clientBearerAuth

Token de acesso do cliente

TipoHTTP (bearer)

Corpo da Requisição

application/json
JSON
{
"id": 1
}

Respostas

Tenant excluído com sucesso

application/json
JSON
{
"status": "success",
"data": null
}

Playground

Autorização
Corpo

Exemplos

Desenvolvido por VitePress OpenAPI