Design / Recipient Use Cases / Remove a Recipient

Remove a Recipient

Overview

In this use case, we’ll walk through permanently deleting a Recipient Account.

A Recipient is a business or individual that you intend to conduct business with on the RocketKOR platform. A Recipient Account contains the recipient’s profile (name, contact information, and so on).

Important Be careful when deleting accounts. Once deleted, accounts cannot be retrieved. Instead of deleting a Recipient Account, you can temporarily suspend the account.

API Operation

Remove a Recipient

Steps

Send a request to the following endpoint:

DELETE /v1/recipients/{recipientId}

Include an Authorization header with your RocketKOR access token as a Bearer Token.
Use {recipientId} to specify the ID of the Recipient Account to be deleted.

Sample Response

If the Recipient Account is successfully deleted, 204 Recipient has been deleted is returned.

				
					{
  204 Recipient has been deleted
}

Remove a Recipient

Overview

API Operation

Steps

Sample Response

ON THIS PAGE