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

Update an IP Pool Name



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.


PUT/v3/send_ips/pools/{poolid}

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

This operation will rename an IP Pool. An IP Pool name cannot start with a dot/period (.) or space.


Authentication

authentication page anchor
Property nameTypeRequiredDescription
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>
Property nameTypeRequiredDescription
poolidstringrequired

Specifies the unique ID for an IP Pool.

SchemaExample
Property nameTypeRequiredDescriptionChild properties
namestringrequired

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

200400401500

OK

SchemaExample
Property nameTypeRequiredDescriptionChild properties
namestring

The name assigned to the IP Pool.


idstring

The unique ID of the IP Pool.

Update an IP Pool Name

update-an-ip-pool-name 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 poolid = "ZGkrHSypTsudrGkmdpJJ";
_22
const data = {
_22
"name": "marketing_pool"
_22
};
_22
_22
const request = {
_22
url: `/v3/send_ips/pools/${poolid}`,
_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: