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

Rename an IP pool



API Overview

api-overview page anchor

IP pools allow you to group your dedicated SendGrid IP addresses. For example, you could create separate one pool for your transactional email and another for your marketing email. When sending marketing emails, specify that you want to use the marketing IP pool. This allows you to maintain separate reputations for your different email traffic.

A single IP address or a range of IP addresses may be dedicated to an account in order to send email for multiple domains. The reputation of this IP is determined by the aggregate performance of all email traffic sent from it.

IP pools can only be used with IP addresses for which you've set up a reverse DNS record.

If an IP pool is not specified for an email, it will use any IP available, including pooled addresses.

Each user can create up to 100 different IP pools.


PUT/v3/ips/pools/{pool_name}

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

This endpoint allows you to update the name of an IP pool.


Authentication

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

The name of the IP pool that you want to retrieve the IP addresses for.

SchemaExample
namestring

The new name for your IP pool.

Max length: 64
200404
SchemaExample
namestring

The name of the IP pool.

Rename an IP pool

rename-an-ip-pool page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_22
const client = require('@sendgrid/client');
_22
client.setApiKey(process.env.SENDGRID_API_KEY);
_22
_22
const pool_name = "per";
_22
const data = {
_22
"name": "new_pool_name"
_22
};
_22
_22
const request = {
_22
url: `/v3/ips/pools/${pool_name}`,
_22
method: 'PUT',
_22
body: data
_22
}
_22
_22
client.request(request)
_22
.then(([response, body]) => {
_22
console.log(response.statusCode);
_22
console.log(response.body);
_22
})
_22
.catch(error => {
_22
console.error(error);
_22
});


Rate this page: