provider Contacts API - Lists DELETE /contactdb/lists/{list_id}
@utdk/sendgrid /contactdb/lists/{list_id}
Delete a List
**This endpoint allows you to delete a specific recipient list with the given ID.**
list_id path required
string
delete_contacts query
Adds the ability to delete all contacts on the list in addition to deleting the list.
enum: true, false
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.

deleteContactdbListsListId
DELETE/contactdb/lists/{list_id}
**This endpoint allows you to delete a specific recipient list with the given ID.**

Parameters

required

Adds the ability to delete all contacts on the list in addition to deleting 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.deleteContactdbListsListId({
  "on-behalf-of": "The subuser's username. This header generates the API call as if the subuser account was making the call."
})