Update Details for an IP Address



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


PATCH/v3/send_ips/ips/{ip}

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

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

This operation updates an IP address's settings, including whether the IP is set to warm up automatically, if the IP is assigned by a parent account, and whether the IP is enabled or disabled. The request body must include at least one of the is_auto_warmup, is_parent_assigned, or is_enabled fields.


Property nameTypeRequiredDescription
authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>
Property nameTypeRequiredDescription
ipstringrequired

The ip path parameter specifies an IP address to make the request against.

Encoding type:application/json
SchemaExample
Property nameTypeRequiredDescriptionChild properties
isAutoWarmupboolean

Optional

Indicates if the IP address is set to automatically warmup.


isParentAssignedboolean

Optional

Indicates if a parent on the account is able to send email from the IP address.


isEnabledboolean

Optional

Indicates if the IP address is billed and able to send email. This parameter applies to non-Twilio SendGrid APIs that been added to your Twilio SendGrid account. This parameter's value is null for Twilio SendGrid IP addresses.

200400401500

OK

SchemaExample
Property nameTypeRequiredDescriptionChild properties
ipstring

The IP address that was updated.


isAutoWarmupboolean

Indicates if the IP address is set to automatically warmup.


isParentAssignedboolean

Indicates if a parent on the account is able to send email from the IP address. This parameter is returned only if the IP address is parent assigned.


isEnabledboolean

An array of Subuser IDs the IP address was assigned to. This parameter is returned only if the IP address is enabled.

1
const client = require("@sendgrid/client");
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3
4
const ip = "ip";
5
const data = {
6
is_auto_warmup: true,
7
is_parent_assigned: true,
8
is_enabled: true,
9
};
10
11
const request = {
12
url: `/v3/send_ips/ips/${ip}`,
13
method: "PATCH",
14
body: data,
15
};
16
17
client
18
.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
});