Skip to content Skip to navigation Skip to topbar

Create an IP Pool with a Name and IP Assignments

API Overview

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.

Operation overview

POST/v3/send_ips/pools

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

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.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstringrequired

Default: Bearer <<YOUR_API_KEY_HERE>>

Request body

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.

Responses

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.

Bad Request

SchemaExample

Property nameTypeRequiredDescriptionChild properties

errorsarray[object]

An array of error objects.

Show child properties for errors

Unauthorized

SchemaExample

Property nameTypeRequiredDescriptionChild properties

errorsarray[object]

An array of error objects.

Show child properties for errors

Internal Server Error

SchemaExample

Property nameTypeRequiredDescriptionChild properties

errorsarray[object]

An array of error objects.

Show child properties for errors

Create an IP Pool with a Name and IP Assignments

Node.js

Python

Java

PHP

Ruby

curl


_25const client = require('@sendgrid/client');
_25client.setApiKey(process.env.SENDGRID_API_KEY);
_25
_25const data = {
_25  "name": "transactional_pool",
_25  "ips": [
_25    "127.0.0.1",
_25    "127.0.0.2"
_25  ]
_25};
_25
_25const request = {
_25  url: `/v3/send_ips/pools`,
_25  method: 'POST',
_25  body: data
_25}
_25
_25client.request(request)
_25  .then(([response, body]) => {
_25    console.log(response.statusCode);
_25    console.log(response.body);
_25  })
_25  .catch(error => {
_25    console.error(error);
_25  });