Skip to contentSkip to navigationSkip to topbar
On this page

Create an IP Pool with a Name and IP Assignments



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

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

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

This operation will create a named IP Pool and associate specified IP addresses with the newly created Pool. This operation requires all IP assignments to succeed. If any IP assignments fail, this endpoint will return an error and the Pool will not be created.

Each IP Pool may have a maximum of 100 assigned IP addresses.


Authentication

authentication page anchor
Property nameTypeRequiredDescription
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>
Encoding type:application/json
SchemaExample
Property nameTypeRequiredDescriptionChild properties
namestringrequired

The name to assign to the IP Pool. An IP Pool name cannot begin with a space or period.


ipsarray[string]Optional

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

201400401500

Created

SchemaExample
Property nameTypeRequiredDescriptionChild properties
namestring

The name assigned to the IP Pool.


idstring

The unique ID of the IP Pool.


ipsarray[string]

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

Create an IP Pool with a Name and IP AssignmentsLink to code sample: Create an IP Pool with a Name and IP Assignments
1
const client = require('@sendgrid/client');
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3
4
const data = {
5
"name": "transactional_pool",
6
"ips": [
7
"127.0.0.1",
8
"127.0.0.2"
9
]
10
};
11
12
const request = {
13
url: `/v3/send_ips/pools`,
14
method: 'POST',
15
body: data
16
}
17
18
client.request(request)
19
.then(([response, body]) => {
20
console.log(response.statusCode);
21
console.log(response.body);
22
})
23
.catch(error => {
24
console.error(error);
25
});