On this page

Delete Multiple lists

API Overview

(warning)

Legacy Marketing Campaigns

You are viewing the Legacy Marketing Campaigns API reference. For guidance migrating to the current version of Marketing Campaigns, see Migrating from Legacy Marketing Campaigns

(information)

Info

For the most up-to-date information on SendGrid's Contact Lists API, please visit the new Marketing Campaigns Lists API.

The Lists API allows you to manage your Marketing Campaigns contact lists. You can create, retrieve, update, and delete lists, as well as add and remove contacts from lists.

Operation overview

DELETE/v3/contactdb/lists

Base url: https://api.sendgrid.com (The Twilio SendGrid v3 API)

This endpoint allows you to delete multiple recipient lists.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstringrequired

Default: Bearer <<YOUR_API_KEY_HERE>>

on-behalf-ofstringOptional

The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Request body

Encoding type:application/json

SchemaExample

array[integer]

Responses

204400401

Schema

Property nameTypeRequiredDescriptionChild properties

No properties defined

All list ids are not valid

SchemaExample

Property nameTypeRequiredDescriptionChild properties

errorsarray[object]

Show child properties for errors

idstring

When applicable, this property value will be an error ID.

SchemaExample

Property nameTypeRequiredDescriptionChild properties

errorsarray[object]

Show child properties for errors

idstring

When applicable, this property value will be an error ID.

Delete Multiple lists

1const client = require('@sendgrid/client');
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const data = [
5  1,
6  2,
7  3,
8  4
9];
10
11const request = {
12  url: `/v3/contactdb/lists`,
13  method: 'DELETE',
14  body: data
15}
16
17client.request(request)
18  .then(([response, body]) => {
19    console.log(response.statusCode);
20    console.log(response.body);
21  })
22  .catch(error => {
23    console.error(error);
24  });