PIpierre
Payment Reminders

DELETE /tools/api/delete-payment-reminder

Exclui ou cancela um lembrete de pagamento. Por padrão realiza exclusão lógica (marca como inactive), mas pode fazer exclusão permanente com hardDelete=true. O usuário só pode excluir seus próprios lembretes. Requer API key para autenticação e assinatura ativa.

Request

  • Base URL
    https://www.pierre.finance
  • URL
    https://www.pierre.finance/tools/api/delete-payment-reminder
  • Auth
    HTTP bearer

Query parameters

reminderIdstring required

ID do lembrete de pagamento a ser excluído

hardDeleteboolean

Se deve fazer exclusão permanente (true) ou apenas cancelar (false, padrão)

Response

Lembrete de pagamento excluído/cancelado com sucesso

successboolean
messagestring
timestampstring date-time

Example response

{
  "success": true,
  "data": {
    "action": "deleted permanently"
  },
  "message": "Payment reminder \"Conta de luz\" deleted permanently successfully"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.