provider Contacts API - Lists DELETE /contactdb/lists/{list_id}/recipients/{recipient_id}
@utdk/sendgrid /contactdb/lists/{list_id}/recipients/{recipient_id}
Delete a Single Recipient from a Single List
**This endpoint allows you to delete a single recipient from a list.**
list_id path required
The ID of the list that you want to add the recipient to.
integer
recipient_id path required
The ID of the recipient you are adding to the list.
string
list_id query required
The ID of the list you are taking this recipient away from.
integer
recipient_id query required
The ID of the recipient to take off the list.
integer
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.

deleteContactdbListsListIdRecipientsRecipientId
DELETE/contactdb/lists/{list_id}/recipients/{recipient_id}
**This endpoint allows you to delete a single recipient from a list.**

Parameters

required

The ID of the list that you want to add the recipient to.

required

The ID of the recipient you are adding to the list.

required

The ID of the list you are taking this recipient away from.

required

The ID of the recipient to take off the list.

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.deleteContactdbListsListIdRecipientsRecipientId({
  "on-behalf-of": "The subuser's username. This header generates the API call as if the subuser account was making the call."
})