Skip to contentSkip to navigationSkip to topbar
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.

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


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

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

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

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
Property nameTypeRequiredDescription
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>
Property nameTypeRequiredDescription
poolidstringrequired

Specifies the unique ID for an IP Pool.

Encoding type:application/json
SchemaExample
Property nameTypeRequiredDescriptionChild properties
ipsarray[string]required

An array of IP addresses to assign to the specified IP Pool. All assignments must succeed.

200400401500

OK

SchemaExample
Property nameTypeRequiredDescriptionChild properties
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 PoolLink to code sample: Add a Batch of IPs to an IP Pool
1
const client = require('@sendgrid/client');
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3
4
const poolid = "ZGkrHSypTsudrGkmdpJJ";
5
const data = {
6
"ips": [
7
"127.0.0.1",
8
"127.0.0.2",
9
"127.0.0.3",
10
"127.0.0.4"
11
]
12
};
13
14
const request = {
15
url: `/v3/send_ips/pools/${poolid}/ips:batchAdd`,
16
method: 'POST',
17
body: data
18
}
19
20
client.request(request)
21
.then(([response, body]) => {
22
console.log(response.statusCode);
23
console.log(response.body);
24
})
25
.catch(error => {
26
console.error(error);
27
});