Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Delete a Single Recipient from a Single List



API Overview

api-overview page anchor
(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.


DELETE/v3/contactdb/lists/{list_id}/recipients/{recipient_id}

Base url: https://api.sendgrid.com

This endpoint allows you to delete a single recipient from a list.


Authentication

authentication page anchor
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.

Property nameTypeRequiredDescription
list_idintegerrequired

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


recipient_idstringrequired

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

Property nameTypeRequiredDescription
list_idintegerrequired

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


recipient_idintegerrequired

The ID of the recipient to take off the list.

Schema
Property nameTypeRequiredDescriptionChild properties

No properties defined

204400401404
Schema
Property nameTypeRequiredDescriptionChild properties

No properties defined

Delete a Single Recipient from a Single List

delete-a-single-recipient-from-a-single-list page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_24
const client = require('@sendgrid/client');
_24
client.setApiKey(process.env.SENDGRID_API_KEY);
_24
_24
const list_id = 4900;
_24
const recipient_id = "ZGkrHSypTsudrGkmdpJJ";
_24
const queryParams = {
_24
"list_id": 4900,
_24
"recipient_id": 4900
_24
};
_24
_24
const request = {
_24
url: `/v3/contactdb/lists/${list_id}/recipients/${recipient_id}`,
_24
method: 'DELETE',
_24
qs: queryParams
_24
}
_24
_24
client.request(request)
_24
.then(([response, body]) => {
_24
console.log(response.statusCode);
_24
console.log(response.body);
_24
})
_24
.catch(error => {
_24
console.error(error);
_24
});


Rate this page: