Skip to contentSkip to navigationSkip to topbar
On this page

Delete an IP Pool



API Overview

api-overview page anchor

The IP Address Management API combines functionality that was previously split between the Twilio SendGrid IP Address API and IP Pools API. This functionality includes adding IP addresses to your account, assigning IP addresses to IP Pools and Subusers, among other tasks. More details about each operation can be found in the descriptions and schemas for each endpoint.

(information)

Info

(warning)

Warning

The IP Address Management API is in public beta at this time. This means the API and documentation are still in development and subject to change without advanced notice.


DELETE/v3/send_ips/pools/{poolid}

Base url: https://api.sendgrid.com (for global users and subusers)

Base url: https://api.eu.sendgrid.com (for EU regional subusers)

This operation deletes an IP Pool and unassigns all IP addresses associated with the Pool. IP addresses associated with the deleted Pool will remain in your account.


Authentication

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

Specifies the unique ID for an IP Pool.

204400401500

No Content

Delete an IP PoolLink to code sample: Delete an IP Pool
1
const client = require('@sendgrid/client');
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3
4
const poolid = "ZGkrHSypTsudrGkmdpJJ";
5
6
const request = {
7
url: `/v3/send_ips/pools/${poolid}`,
8
method: 'DELETE',
9
10
}
11
12
client.request(request)
13
.then(([response, body]) => {
14
console.log(response.statusCode);
15
console.log(response.body);
16
})
17
.catch(error => {
18
console.error(error);
19
});