Delete

Delete

This endpoint permanently removes one or more recipients from TaxBandits. This action cannot be undone. Once deleted, the recipient and its associated data are no longer accessible.

Key Points

• Multiple Deletion — Pass multiple RecipientId or PayeeRef in a single request to delete recipients in bulk.
• IsForcedDelete — By default, deletion is blocked if the recipient has associated returns. Setting IsForcedDelete to TRUE removes this restriction. Use with caution.
• Deactivate Instead — If you want to stop using a recipient without permanently deleting it, consider using the Deactivate endpoint instead.

DELETE recipient/delete

Run in Postman

Request Body

Field	Type	Description
RecipientId	GUID	TaxBandits-generated unique identifier for the recipient.
PayeeRef	String	Your unique identifier for the recipient.
IsForcedDelete	Boolean	Optional When TRUE, deletes the recipient even if tax forms are associated with it.

Response Body

Field	Type	Description
RecipientId	GUID	TaxBandits-generated unique identifier for the recipient.
PayeeRef	String	Your unique identifier for the recipient.
Status	String	Status of the operation.
StatusTs	String	Date and time the operation was completed.
Errors	Object []	Validation error details.
Id	String	Validation error code.
Name	String	Name of the validation rule that failed.
Message	String	Description of the error.

Request JSON

recipient/delete?recipientId=b50601fd-90b8-4e4b-86ce-b87d2b11aa5c&payeeref=PAYEE774&isforceddelete=true

Response JSON

{
    "RecipientId": "9ad0c924-6469-4030-a1be-0a08248a1066",
    "PayeeRef": "DAsdcccdev1",
    "Status": "DELETED",
    "StatusTs": "2026-04-29 10:10:40 -04:00",
    "Errors": null
}