Overview
This endpoint permanently removes a debt from your system. Use with caution as this action cannot be undone.
Authentication
Requires a valid OAuth 2.0 access token with the debts:write scope.
Request
Bearer token for authentication
The encrypted ID of the debt to delete
Example Request
curl -X DELETE "/external-api/v1/debts/abc123def456" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Response
Always false for successful requests
Success message confirming deletion
Success Response
{
"error": false,
"message": "Debt deleted successfully"
}
Important Notes
Permanent Action: Deleting a debt is irreversible. All associated followups and history will also be removed.
- All followups associated with this debt will be deleted
- Payment history will be preserved for accounting purposes
- Reports that include this debt will show it as “deleted”
- Consider updating the status instead of deleting for record-keeping
Error Responses
{
"error": true,
"message": "Access denied to this debt",
"code": 403
}