provider Contacts API - Recipients DELETE /contactdb/recipients/{recipient_id}
@utdk/sendgrid /contactdb/recipients/{recipient_id}
Delete a Recipient
**This endpoint allows you to delete a single recipient with the given ID from your contact database.** > Use this to permanently delete your recipients from all of your contact lists and all segments if required by applicable law.
recipient_id path required
The ID of the recipient that you want to retrieve.
string
on-behalf-of header
string

Try it

Authentication
Configure credentials for Email Activity (beta)
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

deleteContactdbRecipientsRecipientId
DELETE/contactdb/recipients/{recipient_id}
**This endpoint allows you to delete a single recipient with the given ID from your contact database.** > Use this to permanently delete your recipients from all of your contact lists and all segments if required by applicable law.

Parameters

required

The ID of the recipient that you want to retrieve.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import sendgrid from '@utdk/sendgrid';

await sendgrid.deleteContactdbRecipientsRecipientId({
  "on-behalf-of": "The subuser's username. This header generates the API call as if the subuser account was making the call."
})