UnassignRecipient

UnassignRecipient

This endpoint unlinks one or more recipients from a specific business. The recipients are not deleted — they remain in TaxBandits and can be re-assigned later.

POST recipient/unassignrecipients 

Run in Postman

Request Body

Field	Type	Description
BusinessId	GUID	TaxBandits-generated unique identifier for the business.
PayerRef	String	Optional Your unique identifier for the business.
UnAssignRecipients	Object []	An array of recipient objects to unassign from the business.
SequenceId	String	Optional A unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference. Max 10 characters
RecipientId	GUID	Unique identifier of the recipient. Required if PayeeRef is not provided.
PayeeRef	String	Optional Your unique identifier for the recipient. Required if RecipientId is not provided.

Response Body

Field	Type	Description
BusinessId	GUID	TaxBandits-generated unique identifier for the business.
PayerRef	String	Your unique identifier for the business.
SuccessRecipients	Object []	Recipient records that were unassigned successfully.
SequenceId	String	A unique reference ID for the submission that can be used to identify a particular record.
RecipientId	GUID	Unique identifier of 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.
ErrorRecipients	Object []	Records that failed, with details on why.
SequenceId	String	A unique reference ID for the submission that can be used to identify a particular record.
RecipientId	GUID	Identifier of the failed recipient.
PayeeRef	String	Your unique identifier for the recipient.
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.
Errors	Object []	Top-level request errors if the entire request cannot be processed.
Id	String	Validation error code.
Name	String	Name of the validation rule that failed.
Message	String	Description of the error.

Request JSON

{
    "BusinessId": "09c218b3-15e4-4b3e-a0fe-8b2376098b99",
    "PayerRef": "PAYER105",
    "UnAssignRecipients": [
        {
            "SequenceId": "01",
            "RecipientId": "d67539c3-0603-4fb7-9a29-3ae15339269a",
            "PayeeRef": "PAYEE001"
        }
    ]
}

Response JSON

{
    "BusinessId": "09c218b3-15e4-4b3e-a0fe-8b2376098b99",
    "PayerRef": "PAYER105",
    "SuccessRecipients": [
        {
            "SequenceId": "01",
            "RecipientId": "d67539c3-0603-4fb7-9a29-3ae15339269a",
            "PayeeRef": "PAYEE001",
            "Status": "UNASSIGNED",
            "StatusTs": "2026-07-09 06:43:50 -04:00"
        }
    ],
    "ErrorRecipients": null,
    "Errors": null
}