provider Lists DELETE /marketing/lists/{id}
@utdk/sendgrid /marketing/lists/{id}
Delete a list
**This endpoint allows you to deletes a specific list.** Optionally, you can also delete contacts associated to the list. The query parameter, `delete_contacts=true`, will delete the list and start an asynchronous job to delete associated contacts.
id path required
string
delete_contacts query
Flag indicates that all contacts on the list are also to be deleted.
boolean

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.

deleteListsId
DELETE/marketing/lists/{id}
**This endpoint allows you to deletes a specific list.** Optionally, you can also delete contacts associated to the list. The query parameter, `delete_contacts=true`, will delete the list and start an asynchronous job to delete associated contacts.

Parameters

required

Flag indicates that all contacts on the list are also to be deleted.

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.deleteListsId({
  "delete_contacts": false
})