Skip to contentSkip to navigationSkip to topbar
On this page

Remove Contacts from a List



API Overview

api-overview page anchor

Lists are static collections of Marketing Campaigns contacts. This API allows you to interact with the list objects themselves. To add contacts to a list, you must use the Contacts API.

You can also manage your lists using the Contacts menu in the Marketing Campaigns UI(link takes you to an external page). For more information about lists and best practices for building them, see "Building your Contact List".


DELETE/v3/marketing/lists/{id}/contacts

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

This endpoint allows you to remove contacts from a given list.

The contacts will not be deleted. Only their list membership will be changed.


Authentication

authentication page anchor
Property nameTypeRequiredDescription
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>
Property nameTypeRequiredDescription
idstringrequired

The ID of the list on which you want to perform the operation.

Property nameTypeRequiredDescription
contact_idsstringrequired

Comma separated list of contact IDs that you want to remove from the specified contacts list.

Min length: 1
202400404

The removal is accepted and processing.

Schema
Property nameTypeRequiredDescriptionChild properties
job_idstring

job_id of the async job

Remove Contacts from a ListLink to code sample: Remove Contacts from a List
1
const client = require("@sendgrid/client");
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3
4
const id = "ZGkrHSypTsudrGkmdpJJ";
5
const queryParams = {
6
contact_ids: "GkrHSypTsudrGkmdpJJ",
7
};
8
9
const request = {
10
url: `/v3/marketing/lists/${id}/contacts`,
11
method: "DELETE",
12
qs: queryParams,
13
};
14
15
client
16
.request(request)
17
.then(([response, body]) => {
18
console.log(response.statusCode);
19
console.log(response.body);
20
})
21
.catch((error) => {
22
console.error(error);
23
});

Need some help?

Terms of service

Copyright © 2024 Twilio Inc.