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

Delete a Batch of IPs from 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.

(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.


POST/v3/send_ips/pools/{poolid}/ips:batchDelete

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

This operation removes a batch of IPs from an IP Pool. All IPs associated with the Pool will be unassigned from the deleted Pool. However, this operation does not remove the IPs from your account.


Authentication

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

Specifies the unique ID for an IP Pool.

SchemaExample
ipsarray[string]required

An array of IP addresses to remove from the specified IP Pool.

204400401500

No Content

Delete a Batch of IPs from an IP Pool

delete-a-batch-of-ips-from-an-ip-pool page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_27
const client = require('@sendgrid/client');
_27
client.setApiKey(process.env.SENDGRID_API_KEY);
_27
_27
const poolid = "ZGkrHSypTsudrGkmdpJJ";
_27
const data = {
_27
"ips": [
_27
"127.0.0.1",
_27
"127.0.0.2",
_27
"127.0.0.3",
_27
"127.0.0.4"
_27
]
_27
};
_27
_27
const request = {
_27
url: `/v3/send_ips/pools/${poolid}/ips:batchDelete`,
_27
method: 'POST',
_27
body: data
_27
}
_27
_27
client.request(request)
_27
.then(([response, body]) => {
_27
console.log(response.statusCode);
_27
console.log(response.body);
_27
})
_27
.catch(error => {
_27
console.error(error);
_27
});


Rate this page: