Skip to main content
DELETE
/
tools
/
api
/
delete-spending-limit
cURL
curl --request DELETE \
  --url https://www.pierre.finance/tools/api/delete-spending-limit \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "limitId": "<string>"
}
'
{
  "success": true,
  "message": "Spending limit for \"Alimentação\" deleted successfully",
  "deletedLimit": {
    "id": "limit_123456789",
    "category": "Alimentação",
    "limitAmount": 1000.00,
    "period": "monthly"
  },
  "timestamp": "2024-11-04T15:30:00Z"
}
Este endpoint deleta permanentemente um alerta de gastos existente.

Descrição

O endpoint DELETE /tools/api/delete-spending-limit remove permanentemente um alerta de gastos do sistema. Esta ação não pode ser desfeita.

Autenticação

Este endpoint requer autenticação via Bearer token.
Authorization
string
required
Bearer token com a API key do usuário. Formato: Bearer sk-your-api-key-here

Parâmetros de Query

s
string
required
Parâmetro interno para indicar requisições via MCP. Use s=s para requisições MCP.

Body Parameters

limitId
string
required
ID do alerta a ser deletado

Resposta

Sucesso (200)

{
  "success": true,
  "message": "Spending limit for \"Alimentação\" deleted successfully",
  "deletedLimit": {
    "id": "limit_123456789",
    "category": "Alimentação",
    "limitAmount": 1000.00,
    "period": "monthly"
  },
  "timestamp": "2024-11-04T15:30:00Z"
}

Erro de Validação (400)

{
  "error": "Invalid or missing limitId",
  "message": "limitId must be a non-empty string"
}

Erro de Autenticação (401)

{
  "error": "Invalid or inactive API key",
  "message": "Please check your API key and try again",
  "type": "invalid_api_key"
}

Erro de Permissão (403)

{
  "error": "Access denied",
  "message": "You can only delete your own spending limits"
}

Erro - Alerta Não Encontrado (404)

{
  "error": "Spending limit not found",
  "message": "No spending limit found with ID: limit_123456789"
}

Campos da Resposta

success
boolean
required
Indica se a requisição foi bem-sucedida
message
string
required
Mensagem de confirmação da deleção
deletedLimit
object
required
Objeto com informações básicas do alerta deletado
timestamp
string
required
Timestamp da requisição em formato ISO 8601

Exemplos de Uso

cURL

# Deletar um alerta
curl -X DELETE 'https://www.pierre.finance/tools/api/delete-spending-limit' \
  -H 'Authorization: Bearer sk-your-api-key-here' \
  -H 'Content-Type: application/json' \
  -d '{
    "limitId": "limit_123456789"
  }'

JavaScript

const API_KEY = 'sk-your-api-key-here';
const BASE_URL = 'https://www.pierre.finance/tools/api';

async function deleteSpendingLimit(limitId) {
  const response = await fetch(`${BASE_URL}/delete-spending-limit`, {
    method: 'DELETE',
    headers: {
      'Authorization': `Bearer ${API_KEY}`,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({ limitId })
  });
  
  return await response.json();
}

// Exemplo de uso
deleteSpendingLimit('limit_123456789');

Python

import requests

API_KEY = 'sk-your-api-key-here'
BASE_URL = 'https://www.pierre.finance/tools/api'

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

def delete_spending_limit(limit_id):
    data = {'limitId': limit_id}
    response = requests.delete(f'{BASE_URL}/delete-spending-limit',
                             headers=headers, json=data)
    return response.json()

# Exemplo de uso
result = delete_spending_limit('limit_123456789')
print(result['message'])

Códigos de Status

  • 200: Sucesso - Alerta deletado
  • 400: limitId inválido ou ausente
  • 401: Erro de autenticação
  • 403: Acesso negado - alerta pertence a outro usuário
  • 404: Alerta não encontrado
  • 500: Erro interno do servidor
Esta ação é irreversível! Uma vez deletado, o alerta não pode ser recuperado. Todos os dados relacionados ao histórico de alertas também serão removidos. Se você deseja apenas pausar temporariamente um alerta, considere usar o endpoint update-spending-limit com isActive: false ao invés de deletar.
Você só pode deletar alertas que pertencem ao seu usuário. Tentar deletar alertas de outros usuários resultará em erro 403 (Access denied).
Após deletar um alerta, o slot na quota do seu plano fica disponível imediatamente para criar um novo alerta.

Authorizations

Authorization
string
header
required

API key in Bearer token format. Example: Bearer sk-your-api-key-here

Body

application/json
limitId
string
required

ID do limite de gastos a ser excluído

Response

Limite de gastos excluído com sucesso

success
boolean
Example:

true

message
string
Example:

"Spending limit for \"Alimentação\" deleted successfully"

deletedLimit
object
timestamp
string<date-time>