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

Add a Batch of IPs to 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:batchAdd

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

This operation appends a batch of IPs to an IP Pool. This operation requires all IP assignments to succeed. If any IP assignments fail, this endpoint will return an error.


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 assign to the specified IP Pool. All assignments must succeed.

200400401500

OK

SchemaExample
namestring

The name of the IP Pool.


idstring

The unique ID of the IP Pool.


ipsarray[string]

An array of IP addresses assigned to the IP Pool.

Add a Batch of IPs to an IP Pool

add-a-batch-of-ips-to-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:batchAdd`,
_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: