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

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


PUT/v3/send_ips/pools/{poolid}

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

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.

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 NameLink to code sample: Update an IP Pool Name
1
const client = require("@sendgrid/client");
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3
4
const poolid = "ZGkrHSypTsudrGkmdpJJ";
5
const data = {
6
name: "marketing_pool",
7
};
8
9
const request = {
10
url: `/v3/send_ips/pools/${poolid}`,
11
method: "PUT",
12
body: data,
13
};
14
15
client
16
.request(request)
17
.then(([response, body]) => {
18
console.log(response.statusCode);
19
console.log(response.body);
20
})
21
.catch((error) => {
22
console.error(error);
23
});

Need some help?

Terms of service

Copyright © 2024 Twilio Inc.